-
Notifications
You must be signed in to change notification settings - Fork 14.3k
[libc][docgen] regen docgen via cmake #119628
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
11c052b
[libc][docgen] regen docgen via cmake
nickdesaulniers aa0bd7c
expand docgen_list
nickdesaulniers 70f09ec
dynamically generate rst files
nickdesaulniers ce6b5c5
add arpa/inet and sys/mman
nickdesaulniers 0b703e4
fix rebase
nickdesaulniers 97f7183
did I forget to commit strings.yaml?
nickdesaulniers f61903b
fix up alignment
nickdesaulniers ba4c5ae
moar alignment
nickdesaulniers File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,72 @@ | ||
|
||
if (LLVM_ENABLE_SPHINX) | ||
include(AddSphinxTarget) | ||
if (SPHINX_FOUND) | ||
if (${SPHINX_OUTPUT_HTML}) | ||
add_sphinx_target(html libc) | ||
# Similar to clang, we copy our static .rst files from libc/docs/ to the | ||
# $build_dir/libc/docs/. That way, we can have a mix of both static | ||
# (committed) .rst files, and dynamically generated .rst files. We don't | ||
# want the dynamically generated .rst files to pollute the source tree. | ||
add_custom_target(copy-libc-rst-docs | ||
COMMAND "${CMAKE_COMMAND}" -E copy_directory | ||
"${CMAKE_CURRENT_SOURCE_DIR}" "${CMAKE_CURRENT_BINARY_DIR}") | ||
|
||
# For headers that are nested in directories, we need to | ||
# `mkdir $build_dir/libc/docs/headers/$dir` since the above copy_directory | ||
# command does not create such copies. Otherwise, the invocation of docgen | ||
# below will fail since the output file would be placed in a directory that | ||
# does not exist, leading to a `No such file or directory` error from the | ||
# shell. | ||
file(MAKE_DIRECTORY | ||
"${CMAKE_CURRENT_BINARY_DIR}/headers/arpa/" | ||
"${CMAKE_CURRENT_BINARY_DIR}/headers/sys/" | ||
) | ||
|
||
# Change sphinx to build from $build_dir/libc/docs/ rather than | ||
# llvm-project/libc/docs/. | ||
add_sphinx_target(html libc SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}") | ||
# Depend on the copy target. | ||
add_dependencies(docs-libc-html copy-libc-rst-docs) | ||
|
||
# Maintain a list of headers for which we dynamically generate html docs | ||
# for via docgen. For more complex docs (such as per arch support, a la | ||
# math.h), those should be omitted and exist statically in | ||
# libc/docs/headers/. | ||
list(APPEND docgen_list | ||
arpa/inet | ||
assert | ||
ctype | ||
errno | ||
fenv | ||
float | ||
inttypes | ||
locale | ||
setjmp | ||
signal | ||
stdbit | ||
stdio | ||
stdlib | ||
string | ||
strings | ||
sys/mman | ||
threads | ||
uchar | ||
wchar | ||
wctype | ||
) | ||
nickdesaulniers marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
foreach(stem IN LISTS docgen_list) | ||
# It is an error in cmake to have a target name that contains a "/", but | ||
# docgen relies on the "/" to find headers nested under directories. | ||
# Replace with underscore. | ||
string(REPLACE "/" "_" stem_rst ${stem}) | ||
|
||
# docgen invocation. | ||
add_custom_target(${stem_rst} | ||
COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/../utils/docgen/docgen.py ${stem}.h > | ||
${CMAKE_CURRENT_BINARY_DIR}/headers/${stem}.rst) | ||
# depend on the docgen invocation. | ||
add_dependencies(docs-libc-html ${stem_rst}) | ||
endforeach() | ||
endif() | ||
endif() | ||
endif() |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder why these are being highlighted? Are they keywords in CMake? Perhaps I should make this a
;
separated string?