[OpenMP][docs] Revise building manual#176175
Conversation
|
I think updating the documentation not as a single person's job, but the community's task. If you would like changes or addition, please always propose the actual text you would like to see. |
98b62ff to
7acc812
Compare
|
✅ With the latest revision this PR passed the Python code formatter. |
You can test this locally with the following command:darker --check --diff -r origin/main...HEAD openmp/docs/conf.py
View the diff from darker here.--- conf.py 2026-01-15 14:35:05.000000 +0000
+++ conf.py 2026-01-15 14:36:44.363545 +0000
@@ -24,11 +24,16 @@
# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ["sphinx.ext.todo", "sphinx.ext.mathjax", "sphinx.ext.intersphinx", "myst_parser"]
+extensions = [
+ "sphinx.ext.todo",
+ "sphinx.ext.mathjax",
+ "sphinx.ext.intersphinx",
+ "myst_parser",
+]
# Add path for llvm_slug module.
sys.path.insert(0, os.path.abspath(os.path.join("..", "..", "llvm", "docs")))
|
jhuber6
left a comment
There was a problem hiding this comment.
Very good cleanup and simplification.
I also didn't know you could mix markdown and restructured text like this
LLVM's docs do so. It would probably be infeasable to convert all ReST to Markdown at once if this was not the case: https://reviews.llvm.org/D44910 |
shiltian
left a comment
There was a problem hiding this comment.
Thanks for the detailed documents!
…HE variable in legacy runtime build
|
@Meinersbur: May I draw your attention to issue #174701? There I ran into an OpenMP build error when CLANG_DEFAULT_CXX_STDLIB=libc++ is used while building OpenMP as a runtime. Will there be a solution mentioned for this issue in your planned OpenMP build documentation? The build process worked fine as long as OpenMP was built as a project (which is no longer an option after #152189 was merged). |
|
@pkl97 The documentation is not supposed to be a bug tracker. Please keep the discussion of an issue to that issue #. |
Go into more detail on the two non-legacy build modes. I decided use create a dedicated document documention the build process. `index.rst` only keeps the "Getting Started" part. `README.rst` is vastly outdated with the still valid parts integrated into the new documentation. `SupportAndFAQ.rst` is unstructured and keeps only the non-building parts. The the new building document is written in Meltdown, following the decision from LLVM.
Go into more detail on the two non-legacy build modes. I decided use create a dedicated document documention the build process. `index.rst` only keeps the "Getting Started" part. `README.rst` is vastly outdated with the still valid parts integrated into the new documentation. `SupportAndFAQ.rst` is unstructured and keeps only the non-building parts. The the new building document is written in Meltdown, following the decision from LLVM.
Go into more detail on the two non-legacy build modes and consolidate build instructions from different files into a dedicated document.
index.rstonly keeps the "Getting Started" part.README.rstis vastly outdated with the still valid parts integrated into the new documentation.SupportAndFAQ.rstis unstructured and keep only the non-building parts. Make the doxygen-integrated instructions link to the web resource.The the new building document is written in Meltdown, following the decision from LLVM.