[libc-commits] [libc] [docs][libc] Add AIO documentation refering POSIX and include in build (PR #122219)
via libc-commits
libc-commits at lists.llvm.org
Thu Jan 9 17:23:42 PST 2025
https://github.com/StarOne01 updated https://github.com/llvm/llvm-project/pull/122219
>From 1139d059c00c47ff1c7f3037ea76816379a03f3c Mon Sep 17 00:00:00 2001
From: Prashanth <TheStarOne01 at proton.me>
Date: Thu, 9 Jan 2025 05:21:20 +0000
Subject: [PATCH 1/3] [docs][libc] Add AIO documentation refering POSIX and
include in build
---
libc/docs/CMakeLists.txt | 1 +
libc/docs/headers/index.rst | 1 +
libc/utils/docgen/aio.yaml | 49 +++++++++++++++++++++++++++++++++++++
3 files changed, 51 insertions(+)
create mode 100644 libc/utils/docgen/aio.yaml
diff --git a/libc/docs/CMakeLists.txt b/libc/docs/CMakeLists.txt
index 5a3f8275bb932e..f48005f303436a 100644
--- a/libc/docs/CMakeLists.txt
+++ b/libc/docs/CMakeLists.txt
@@ -32,6 +32,7 @@ if (SPHINX_FOUND)
# math.h), those should be omitted and exist statically in
# libc/docs/headers/.
list(APPEND docgen_list
+ aio
arpa/inet
assert
ctype
diff --git a/libc/docs/headers/index.rst b/libc/docs/headers/index.rst
index 07ab6dd9b26742..70fb04089d9a29 100644
--- a/libc/docs/headers/index.rst
+++ b/libc/docs/headers/index.rst
@@ -4,6 +4,7 @@ Implementation Status
.. toctree::
:maxdepth: 1
+ aio
arpa/inet
assert
complex
diff --git a/libc/utils/docgen/aio.yaml b/libc/utils/docgen/aio.yaml
new file mode 100644
index 00000000000000..d3d9418f54b136
--- /dev/null
+++ b/libc/utils/docgen/aio.yaml
@@ -0,0 +1,49 @@
+macros:
+ AIO_ALLDONE:
+ in-latest-posix: ''
+ AIO_CANCELED:
+ in-latest-posix: ''
+ AIO_NOTCANCELED:
+ in-latest-posix: ''
+ LIO_NOP:
+ in-latest-posix: ''
+ LIO_NOWAIT:
+ in-latest-posix: ''
+ LIO_READ:
+ in-latest-posix: ''
+ LIO_WAIT:
+ in-latest-posix: ''
+ LIO_WRITE:
+ in-latest-posix: ''
+
+functions:
+ aio_fildes:
+ in-latest-posix: ''
+ aio_offset:
+ in-latest-posix: ''
+ aio_buf:
+ in-latest-posix: ''
+ aio_nbytes:
+ in-latest-posix: ''
+ aio_reqprio:
+ in-latest-posix: ''
+ aio_sigevent:
+ in-latest-posix: ''
+ aio_lio_opcode:
+ in-latest-posix: ''
+ aio_cancel:
+ in-latest-posix: ''
+ aio_error:
+ in-latest-posix: ''
+ aio_fsync:
+ in-latest-posix: ''
+ aio_read:
+ in-latest-posix: ''
+ aio_return:
+ in-latest-posix: ''
+ aio_suspend:
+ in-latest-posix: ''
+ aio_write:
+ in-latest-posix: ''
+ lio_listio:
+ in-latest-posix: ''
>From 5509b350ac4676203e0afc7e6fb2bdd1ad08db49 Mon Sep 17 00:00:00 2001
From: Prashanth <TheStarOne01 at proton.me>
Date: Thu, 9 Jan 2025 16:20:34 +0000
Subject: [PATCH 2/3] Update aio.yaml to reorder functions and ensure
consistency in POSIX documentation
---
libc/utils/docgen/aio.yaml | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/libc/utils/docgen/aio.yaml b/libc/utils/docgen/aio.yaml
index d3d9418f54b136..1b877639e0fcb0 100644
--- a/libc/utils/docgen/aio.yaml
+++ b/libc/utils/docgen/aio.yaml
@@ -17,30 +17,30 @@ macros:
in-latest-posix: ''
functions:
- aio_fildes:
- in-latest-posix: ''
- aio_offset:
- in-latest-posix: ''
aio_buf:
in-latest-posix: ''
- aio_nbytes:
+ aio_cancel:
in-latest-posix: ''
- aio_reqprio:
+ aio_error:
in-latest-posix: ''
- aio_sigevent:
+ aio_fildes:
in-latest-posix: ''
- aio_lio_opcode:
+ aio_fsync:
in-latest-posix: ''
- aio_cancel:
+ aio_lio_opcode:
in-latest-posix: ''
- aio_error:
+ aio_nbytes:
in-latest-posix: ''
- aio_fsync:
+ aio_offset:
in-latest-posix: ''
aio_read:
in-latest-posix: ''
+ aio_reqprio:
+ in-latest-posix: ''
aio_return:
in-latest-posix: ''
+ aio_sigevent:
+ in-latest-posix: ''
aio_suspend:
in-latest-posix: ''
aio_write:
>From 64dd418e1e1fc91eb2e6abd2ca5d5fb3e89814de Mon Sep 17 00:00:00 2001
From: Prashanth <TheStarOne01 at proton.me>
Date: Fri, 10 Jan 2025 01:23:13 +0000
Subject: [PATCH 3/3] Update aio.yaml to remove struct field entries
---
libc/utils/docgen/aio.yaml | 14 --------------
1 file changed, 14 deletions(-)
diff --git a/libc/utils/docgen/aio.yaml b/libc/utils/docgen/aio.yaml
index 1b877639e0fcb0..2c381558676a18 100644
--- a/libc/utils/docgen/aio.yaml
+++ b/libc/utils/docgen/aio.yaml
@@ -17,30 +17,16 @@ macros:
in-latest-posix: ''
functions:
- aio_buf:
- in-latest-posix: ''
aio_cancel:
in-latest-posix: ''
aio_error:
in-latest-posix: ''
- aio_fildes:
- in-latest-posix: ''
aio_fsync:
in-latest-posix: ''
- aio_lio_opcode:
- in-latest-posix: ''
- aio_nbytes:
- in-latest-posix: ''
- aio_offset:
- in-latest-posix: ''
aio_read:
in-latest-posix: ''
- aio_reqprio:
- in-latest-posix: ''
aio_return:
in-latest-posix: ''
- aio_sigevent:
- in-latest-posix: ''
aio_suspend:
in-latest-posix: ''
aio_write:
More information about the libc-commits
mailing list