From 7c47b70154b550bdf95aa4042d3a0404e817bb7b Mon Sep 17 00:00:00 2001 From: Robert Cohn Date: Wed, 7 Sep 2022 11:18:18 -0400 Subject: [PATCH] cleanup for 1.2 provisional rev 1 (#436) --- README.rst | 4 ++++ scripts/oneapi.py | 13 ------------- source/elements/oneCCL/source/spec/main_objects.rst | 2 +- source/elements/oneDAL/Doxyfile | 13 ------------- source/elements/oneDNN/Doxyfile | 13 ------------- .../functions/collaborative_call_once_func.rst | 2 +- source/elements/oneVPL/Doxyfile | 13 ------------- source/spelling_wordlist.txt | 3 +++ 8 files changed, 9 insertions(+), 54 deletions(-) diff --git a/README.rst b/README.rst index 981ac725d..0acaa8c18 100644 --- a/README.rst +++ b/README.rst @@ -101,6 +101,10 @@ Build the pdf version wit the following command:: The generated PDF will be located at build/latexpdf/oneAPI-spec.pdf. +Spell check:: + + python oneapi.doc. --verbose spelling + -- CI -- diff --git a/scripts/oneapi.py b/scripts/oneapi.py index b48e4516a..1d4ce2129 100644 --- a/scripts/oneapi.py +++ b/scripts/oneapi.py @@ -9,7 +9,6 @@ import os.path import shutil import subprocess -from distutils.dir_util import copy_tree as copy_tree_update from functools import wraps from os.path import join @@ -74,18 +73,6 @@ def rm(dir): shutil.rmtree(dir, ignore_errors=True) -def copytree(src, dst, dirs_exist_ok=False): - log('cp -r', src, dst) - if cl_args.dry_run: - return - # dirs_exist_ok needs python 3.8 or later, use copy_tree_update - # for now - if dirs_exist_ok: - copy_tree_update(src, dst) - else: - shutil.copytree(src, dst) - - def copy(src, dst): log('cp', src, dst) if cl_args.dry_run: diff --git a/source/elements/oneCCL/source/spec/main_objects.rst b/source/elements/oneCCL/source/spec/main_objects.rst index bac12b1f4..ec1e6dacb 100644 --- a/source/elements/oneCCL/source/spec/main_objects.rst +++ b/source/elements/oneCCL/source/spec/main_objects.rst @@ -205,7 +205,7 @@ Communicator oneCCL specification defines ``communicator`` class that describes a group of communicating ranks, where a rank is an addressable entity in a communication operation and corresponds to single oneCCL device. -``communicator`` defines communication operations on memory buffers between homogenous oneCCL devices, that is, all oneCCL devices either wrap native device objects of the same type (for example CPUs only or GPUs only) or do not wrap native objects. +``communicator`` defines communication operations on memory buffers between homogeneous oneCCL devices, that is, all oneCCL devices either wrap native device objects of the same type (for example CPUs only or GPUs only) or do not wrap native objects. Each process may correspond to multiple ranks. diff --git a/source/elements/oneDAL/Doxyfile b/source/elements/oneDAL/Doxyfile index 2a5dd1897..588295e31 100644 --- a/source/elements/oneDAL/Doxyfile +++ b/source/elements/oneDAL/Doxyfile @@ -267,12 +267,6 @@ TAB_SIZE = 4 ALIASES = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all @@ -1154,13 +1148,6 @@ VERBATIM_HEADERS = YES ALPHABETICAL_INDEX = YES -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored diff --git a/source/elements/oneDNN/Doxyfile b/source/elements/oneDNN/Doxyfile index b3d2ea072..ce427bd87 100644 --- a/source/elements/oneDNN/Doxyfile +++ b/source/elements/oneDNN/Doxyfile @@ -267,12 +267,6 @@ TAB_SIZE = 4 ALIASES = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all @@ -1154,13 +1148,6 @@ CLANG_OPTIONS = ALPHABETICAL_INDEX = YES -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored diff --git a/source/elements/oneTBB/source/algorithms/functions/collaborative_call_once_func.rst b/source/elements/oneTBB/source/algorithms/functions/collaborative_call_once_func.rst index 18704cb7e..db781034e 100644 --- a/source/elements/oneTBB/source/algorithms/functions/collaborative_call_once_func.rst +++ b/source/elements/oneTBB/source/algorithms/functions/collaborative_call_once_func.rst @@ -48,7 +48,7 @@ Example ------- The following example shows a class in which the "Lazy initialization" pattern is implemented on -the "cachedProperty" field. +the ``cachedProperty`` field. .. code:: cpp diff --git a/source/elements/oneVPL/Doxyfile b/source/elements/oneVPL/Doxyfile index 5d325ad7f..86270ea4c 100644 --- a/source/elements/oneVPL/Doxyfile +++ b/source/elements/oneVPL/Doxyfile @@ -267,12 +267,6 @@ TAB_SIZE = 4 ALIASES = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all @@ -1154,13 +1148,6 @@ CLANG_OPTIONS = ALPHABETICAL_INDEX = YES -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored diff --git a/source/spelling_wordlist.txt b/source/spelling_wordlist.txt index 58c661c44..236e9b27e 100644 --- a/source/spelling_wordlist.txt +++ b/source/spelling_wordlist.txt @@ -811,3 +811,6 @@ zgebrd ≥ fi fl +parmeterizes +QNaN +decrementing