[libc][docs] add sys/wait to documentation and include related functi… #122598
Conversation
This file contains 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
|
@llvm/pr-subscribers-libc Author: Prashanth (StarOne01) ChangesChanges:
These changes ensure that the Full diff: https://github.com/llvm/llvm-project/pull/122598.diff 3 Files Affected:
diff --git a/libc/docs/CMakeLists.txt b/libc/docs/CMakeLists.txt
index 4fa621fb2a0510..eabb26b9aa6b13 100644
--- a/libc/docs/CMakeLists.txt
+++ b/libc/docs/CMakeLists.txt
@@ -53,6 +53,7 @@ if (SPHINX_FOUND)
string
strings
sys/mman
+ sys/wait
threads
uchar
wchar
diff --git a/libc/docs/headers/index.rst b/libc/docs/headers/index.rst
index 2295a8cc8853cd..694b4b6f1a6b1c 100644
--- a/libc/docs/headers/index.rst
+++ b/libc/docs/headers/index.rst
@@ -26,6 +26,7 @@ Implementation Status
string
strings
sys/mman
+ sys/wait
threads
time
uchar
diff --git a/libc/utils/docgen/sys/wait.yaml b/libc/utils/docgen/sys/wait.yaml
new file mode 100644
index 00000000000000..bf801073b7b8c8
--- /dev/null
+++ b/libc/utils/docgen/sys/wait.yaml
@@ -0,0 +1,35 @@
+functions:
+ wait:
+ in-latest-posix: ''
+ waitid:
+ in-latest-posix: ''
+ waitpid:
+ in-latest-posix: ''
+
+macros:
+ WCONTINUED:
+ in-latest-posix: ''
+ WEXITED:
+ in-latest-posix: ''
+ WEXITSTATUS:
+ in-latest-posix: ''
+ WIFCONTINUED:
+ in-latest-posix: ''
+ WIFEXITED:
+ in-latest-posix: ''
+ WIFSIGNALED:
+ in-latest-posix: ''
+ WIFSTOPPED:
+ in-latest-posix: ''
+ WNOHANG:
+ in-latest-posix: ''
+ WNOWAIT:
+ in-latest-posix: ''
+ WSTOPPED:
+ in-latest-posix: ''
+ WSTOPSIG:
+ in-latest-posix: ''
+ WTERMSIG:
+ in-latest-posix: ''
+ WUNTRACED:
+ in-latest-posix: ''
\ No newline at end of file
|
nickdesaulniers
requested changes
Jan 14, 2025
There was a problem hiding this comment.
It's faster to review these if you define things in the order they appear in the posix docs. They will get alphabetically sorted when generating the rst files. You don't need to resort this file, but for future PRs please keep that in mind.
Thanks for the patch!
|
Done! I believe you mentioned it somewhere to
I guess, i misunderstood it for the whole doc instead of just index files. |
nickdesaulniers
approved these changes
Jan 15, 2025
paulhuggett
pushed a commit
to paulhuggett/llvm-project
that referenced
this pull request
Jan 16, 2025
llvm#122598) These changes ensure that the `sys/wait` header is documented properly with respect to the issue (llvm#122006 ). **Changes:** 1. **wait.yaml**: Created a new YAML file for `sys/wait` with functions (`wait`, `waitid`, `waitpid`) and related macros. 2. **CMakeLists.txt**: Added `sys/wait` to the documentation directories. 3. **index.rst**: Included `sys/wait` in the documentation index.
DKLoehr
pushed a commit
to DKLoehr/llvm-project
that referenced
this pull request
Jan 17, 2025
llvm#122598) These changes ensure that the `sys/wait` header is documented properly with respect to the issue (llvm#122006 ). **Changes:** 1. **wait.yaml**: Created a new YAML file for `sys/wait` with functions (`wait`, `waitid`, `waitpid`) and related macros. 2. **CMakeLists.txt**: Added `sys/wait` to the documentation directories. 3. **index.rst**: Included `sys/wait` in the documentation index.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
These changes ensure that the
sys/waitheader is documented properly with respect to the issue (#122006 ).Changes:
sys/waitwith functions (wait,waitid,waitpid) and related macros.sys/waitto the documentation directories.sys/waitin the documentation index.