Skip to content

Commit b880552

Browse files
committed
[OpenMP][Docs] Updated the OpenMP documentation about building the OpenMP documentation with Sphinx
When I was trying to improve the OpenMP documentation, I found that the information in `OpenMP/docs/README.md` did not contain up-to-date information about how to build the OpenMP documentation with Sphinx. When I ran `make docs-openmp-html`, the command failed because there were a few syntax errors in `openmp/docs/design/Runtimes.rst`. This commit fixes the syntax errors and updates the documentation on building the OpenMP documentation. Reviewed By: jdoerfert Differential Revision: https://reviews.llvm.org/D156470
1 parent 4166ff6 commit b880552

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

openmp/docs/README.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ If you instead would like to generate and view the HTML locally, install
1212
Sphinx <http://sphinx-doc.org/> and then do:
1313

1414
cd <build-dir>
15-
cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
16-
make
17-
$BROWSER <build-dir>/projects/openmp/docs//html/index.html
15+
cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true -DCMAKE_MODULE_PATH=/path/to/llvm/cmake/modules <src-dir>
16+
make docs-openmp-html
17+
$BROWSER <build-dir>/docs/html/index.html
1818

1919
The mapping between reStructuredText files and generated documentation is
2020
`docs/Foo.rst` <-> `<build-dir>/projects/openmp/docs//html/Foo.html` <->

openmp/docs/design/Runtimes.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ The ``offset`` specifier indicates the starting position for thread assignment.
376376
granularity down to group since that is the largest granularity allowed by the OS.
377377

378378
KMP_HIDDEN_HELPER_AFFINITY (Windows, Linux)
379-
"""""""""""""""""""""""""""""
379+
"""""""""""""""""""""""""""""""""""""""""""
380380

381381
Enables run-time library to bind hidden helper threads to physical processing units.
382382
This environment variable has the same syntax and semantics as ``KMP_AFFINIY`` but only
@@ -1058,6 +1058,7 @@ value of the ``LIBOMPTARGET_MAP_FORCE_ATOMIC`` environment variable.
10581058
The default behavior of LLVM 14 is to force atomic maps clauses, prior versions
10591059
of LLVM did not.
10601060

1061+
.. _libomptarget_jit_opt_level:
10611062

10621063
LIBOMPTARGET_JIT_OPT_LEVEL
10631064
""""""""""""""""""""""""""
@@ -1083,6 +1084,8 @@ assembler in object format for the respective target. The JIT optimization
10831084
pipeline and backend are skipped and only target specific post-processing is
10841085
performed on the object file before it is loaded onto the device.
10851086

1087+
.. _libomptarget_jit_replacement_module:
1088+
10861089
LIBOMPTARGET_JIT_REPLACEMENT_MODULE
10871090
"""""""""""""""""""""""""""""""""""
10881091

@@ -1096,6 +1099,7 @@ llvm tools (llvm-objdump), or, simply, by setting the
10961099
:ref:`LIBOMPTARGET_JIT_PRE_OPT_IR_MODULE` or
10971100
:ref:`LIBOMPTARGET_JIT_POST_OPT_IR_MODULE` environment variables.
10981101

1102+
.. _libomptarget_jit_pre_opt_ir_module:
10991103

11001104
LIBOMPTARGET_JIT_PRE_OPT_IR_MODULE
11011105
""""""""""""""""""""""""""""""""""
@@ -1107,6 +1111,7 @@ which the LLVM-IR module is written. The module can be the analyzed, and
11071111
transformed and loaded back into the JIT pipeline via
11081112
:ref:`LIBOMPTARGET_JIT_REPLACEMENT_MODULE`.
11091113

1114+
.. _libomptarget_jit_post_opt_ir_module:
11101115

11111116
LIBOMPTARGET_JIT_POST_OPT_IR_MODULE
11121117
"""""""""""""""""""""""""""""""""""
@@ -1126,7 +1131,7 @@ This environment variable defines a lower bound for the number of threads if a
11261131
combined kernel, e.g., `target teams distribute parallel for`, has insufficient
11271132
parallelism. Especially if the trip count of the loops is lower than the number
11281133
of threads possible times the number of teams (aka. blocks) the device preferes
1129-
(see also :ref:`LIBOMPTARGET_AMDGPU_TEAMS_PER_CU), we will reduce the thread
1134+
(see also :ref:`LIBOMPTARGET_AMDGPU_TEAMS_PER_CU`), we will reduce the thread
11301135
count to increase outer (team/block) parallelism. The thread count will never
11311136
be reduced below the value passed for this environment variable though.
11321137

@@ -1225,6 +1230,8 @@ plugin. The size is the number of AQL packets an HSA queue is expected to hold.
12251230
It is also the number of AQL packets that can be pushed into each queue without
12261231
waiting the driver to process them. The default value is ``512``.
12271232

1233+
.. _libomptarget_amdgpu_teams_per_cu:
1234+
12281235
LIBOMPTARGET_AMDGPU_TEAMS_PER_CU
12291236
""""""""""""""""""""""""""""""""
12301237

0 commit comments

Comments
 (0)