[libc-commits] [libc] added cpio header (PR #123798)

[via libc-commits]

https://github.com/siya100 created https://github.com/llvm/llvm-project/pull/123798

[libc][docs] add cpio to documentation and include related functi… 
These changes ensure that the cpio header is documented properly
with respect to the issue (https://github.com/llvm/llvm-project/issues/122006 ).

**Changes:**
1. **cpio.yaml**: Created a new YAML file for cpio with functions
and related macros.
2. **CMakeLists.txt**: Added cpio to the documentation
directories.
3. **index.rst**: Included `cpio` in the documentation index.

>From ed3453cc5780923a705baaa19a759c370f84343b Mon Sep 17 00:00:00 2001
From: siya <siya at Siya.com>
Date: Tue, 21 Jan 2025 18:08:56 +0000
Subject: [PATCH 1/2] Document POSIX header cpio.h

---
 libc/docs/headers/index.rst |  1 +
 libc/utils/docgen/cpio.yaml | 31 +++++++++++++++++++++++++++++++
 2 files changed, 32 insertions(+)
 create mode 100644 libc/utils/docgen/cpio.yaml

diff --git a/libc/docs/headers/index.rst b/libc/docs/headers/index.rst
index 858b2142defa92..e457df558b1398 100644
--- a/libc/docs/headers/index.rst
+++ b/libc/docs/headers/index.rst
@@ -8,6 +8,7 @@ Implementation Status
    arpa/inet
    assert
    complex
+   cpio
    ctype
    errno
    fenv
diff --git a/libc/utils/docgen/cpio.yaml b/libc/utils/docgen/cpio.yaml
new file mode 100644
index 00000000000000..d2371c9efb9d3f
--- /dev/null
+++ b/libc/utils/docgen/cpio.yaml
@@ -0,0 +1,31 @@
+functions:
+  cpio_open:
+    in-latest-posix: ''
+  cpio_create:
+    in-latest-posix: ''
+  cpio_read:
+    in-latest-posix: ''
+  cpio_write:
+    in-latest-posix: ''
+  cpio_close:
+    in-latest-posix: ''
+macros:
+  CPIO_ACCESS:
+    in-latest-posix: ''
+  CPIO_CREATE:
+    in-latest-posix: ''
+  CPIO_EXTRACT:
+    in-latest-posix: ''
+  CPIO_LINK:
+    in-latest-posix: ''
+  CPIO_RENAME:
+    in-latest-posix: ''
+  CPIO_SYMLINK:
+    in-latest-posix: ''
+  CPIO_DELETE:
+    in-latest-posix: ''
+  CPIO_TRUNCATE:
+    in-latest-posix: ''
+  CPIO_UNLINK:
+    in-latest-posix: ''
+

>From b207e4346e04a7cb311c2254d750cd51d788c1c7 Mon Sep 17 00:00:00 2001
From: siya <siya at Siya.com>
Date: Tue, 21 Jan 2025 18:09:35 +0000
Subject: [PATCH 2/2] Document POSIX header cpio.h

---
 libc/docs/CMakeLists.txt | 1 +
 1 file changed, 1 insertion(+)

diff --git a/libc/docs/CMakeLists.txt b/libc/docs/CMakeLists.txt
index f88d7c27f9f6b3..b2ead3ffc5e657 100644
--- a/libc/docs/CMakeLists.txt
+++ b/libc/docs/CMakeLists.txt
@@ -37,6 +37,7 @@ if (SPHINX_FOUND)
       aio
       arpa/inet
       assert
+      cpio
       ctype
       errno
       fenv