Skip to content

[OpenMP][docs] Revise building manual#176175

Merged
Meinersbur merged 11 commits intollvm:mainfrom
Meinersbur:openmp_docs_building
Jan 28, 2026
Merged

[OpenMP][docs] Revise building manual#176175
Meinersbur merged 11 commits intollvm:mainfrom
Meinersbur:openmp_docs_building

Conversation

@Meinersbur
Copy link
Member

@Meinersbur Meinersbur commented Jan 15, 2026

Go into more detail on the two non-legacy build modes and consolidate build instructions from different files into a dedicated document. 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 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.

@Meinersbur
Copy link
Member Author

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.

@Meinersbur Meinersbur force-pushed the openmp_docs_building branch from 98b62ff to 7acc812 Compare January 15, 2026 14:35
@Meinersbur Meinersbur marked this pull request as ready for review January 15, 2026 14:36
@llvmbot llvmbot added openmp:libomp OpenMP host runtime openmp:libomptarget OpenMP offload runtime labels Jan 15, 2026
@github-actions
Copy link

github-actions bot commented Jan 15, 2026

✅ With the latest revision this PR passed the Python code formatter.

@github-actions
Copy link

⚠️ Python code formatter, darker found issues in your code. ⚠️

You can test this locally with the following command:
darker --check --diff -r origin/main...HEAD openmp/docs/conf.py

⚠️
The reproduction instructions above might return results for more than one PR
in a stack if you are using a stacked PR workflow. You can limit the results by
changing origin/main to the base branch/commit you want to compare against.
⚠️

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")))
 
 

Copy link
Contributor

@jhuber6 jhuber6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good cleanup and simplification.

I also didn't know you could mix markdown and restructured text like this

@Meinersbur
Copy link
Member Author

Meinersbur commented Jan 15, 2026

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

Copy link
Contributor

@shiltian shiltian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the detailed documents!

@pkl97
Copy link

pkl97 commented Jan 16, 2026

@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).

@Meinersbur
Copy link
Member Author

@pkl97 The documentation is not supposed to be a bug tracker. Please keep the discussion of an issue to that issue #.

@Meinersbur Meinersbur merged commit dd76d33 into llvm:main Jan 28, 2026
12 checks passed
honeygoyal pushed a commit to honeygoyal/llvm-project that referenced this pull request Jan 30, 2026
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.
sshrestha-aa pushed a commit to sshrestha-aa/llvm-project that referenced this pull request Feb 4, 2026
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

openmp:libomp OpenMP host runtime openmp:libomptarget OpenMP offload runtime

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants