Skip to content
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

[docs][libc] Add AIO documentation refering POSIX and include in build #122219

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

StarOne01
Copy link

With reference to #122006 , add a new header reference (aio.yaml) to doc

Copy link

github-actions bot commented Jan 9, 2025

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@llvmbot llvmbot added the libc label Jan 9, 2025
@llvmbot
Copy link
Member

llvmbot commented Jan 9, 2025

@llvm/pr-subscribers-libc

Author: Prashanth (StarOne01)

Changes

With reference to #122006 , add a new header reference (aio.yaml) to doc


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

3 Files Affected:

  • (modified) libc/docs/CMakeLists.txt (+1)
  • (modified) libc/docs/headers/index.rst (+1)
  • (added) libc/utils/docgen/aio.yaml (+49)
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: ''

@nickdesaulniers nickdesaulniers self-requested a review January 9, 2025 17:39
Copy link
Member

@nickdesaulniers nickdesaulniers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the patch!

Comment on lines +20 to +21
aio_buf:
in-latest-posix: ''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't see aio_buf in https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/aio.h.html. Can you triple check?

Comment on lines +26 to +27
aio_fildes:
in-latest-posix: ''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a function in https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/aio.h.html. Looks like a member of struct aiocb (we don't need to document those). It's possible perhaps it was deprecated/removed from POSIX though. Can you check?

Comment on lines +30 to +31
aio_lio_opcode:
in-latest-posix: ''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a fn

Comment on lines +32 to +33
aio_nbytes:
in-latest-posix: ''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a fn

Comment on lines +34 to +35
aio_offset:
in-latest-posix: ''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a fn

Comment on lines +38 to +39
aio_reqprio:
in-latest-posix: ''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a fn

Comment on lines +42 to +43
aio_sigevent:
in-latest-posix: ''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a fn

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants