[libc-commits] [libc] [libc][docs] add sys/wait to documentation and include related functi… (PR #122598)

via libc-commits libc-commits at lists.llvm.org
Sat Jan 11 08:32:08 PST 2025


llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-libc

Author: Prashanth (StarOne01)

<details>
<summary>Changes</summary>

**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. 

These changes ensure that the `sys/wait` header is documented properly.

---
Full diff: https://github.com/llvm/llvm-project/pull/122598.diff


3 Files Affected:

- (modified) libc/docs/CMakeLists.txt (+1) 
- (modified) libc/docs/headers/index.rst (+1) 
- (added) libc/utils/docgen/sys/wait.yaml (+35) 


``````````diff
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

``````````

</details>


https://github.com/llvm/llvm-project/pull/122598


More information about the libc-commits mailing list