Skip to content

[libc][docs] Add pwd.h POSIX header documentation#186292

Merged
kaladron merged 2 commits intollvm:mainfrom
kovan:docs/pwd-h
May 1, 2026
Merged

[libc][docs] Add pwd.h POSIX header documentation#186292
kaladron merged 2 commits intollvm:mainfrom
kovan:docs/pwd-h

Conversation

@kovan
Copy link
Copy Markdown
Contributor

@kovan kovan commented Mar 13, 2026

Add YAML metadata for pwd.h listing all POSIX-mandated functions
(endpwent, getpwent, getpwnam, getpwnam_r, getpwuid,
getpwuid_r, setpwent). This header defines no macros per POSIX.

Add pwd to index.rst and CMakeLists.txt docgen_list.

Verified with python3 docgen.py pwd.h — generates valid RST with correct POSIX links.

Partial fix for #122006

@github-actions
Copy link
Copy Markdown

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 Mar 13, 2026
@llvmbot
Copy link
Copy Markdown
Member

llvmbot commented Mar 13, 2026

@llvm/pr-subscribers-libc

Author: None (kovan)

Changes

Add YAML metadata for pwd.h listing all POSIX-mandated functions
(endpwent, getpwent, getpwnam, getpwnam_r, getpwuid,
getpwuid_r, setpwent). This header defines no macros per POSIX.

Add pwd to index.rst and CMakeLists.txt docgen_list.

Verified with python3 docgen.py pwd.h — generates valid RST with correct POSIX links.

Partial fix for #122006


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

3 Files Affected:

  • (modified) libc/docs/CMakeLists.txt (+1)
  • (modified) libc/docs/headers/index.rst (+1)
  • (added) libc/utils/docgen/pwd.yaml (+15)
diff --git a/libc/docs/CMakeLists.txt b/libc/docs/CMakeLists.txt
index 68fe9fc545781..b0797740c68ce 100644
--- a/libc/docs/CMakeLists.txt
+++ b/libc/docs/CMakeLists.txt
@@ -56,6 +56,7 @@ if (SPHINX_FOUND)
       netinet/in
       # TODO: https://github.com/llvm/llvm-project/issues/123821
       # pthread
+      pwd
       setjmp
       signal
       stdbit
diff --git a/libc/docs/headers/index.rst b/libc/docs/headers/index.rst
index 573c5d185f38a..541d71f6851fb 100644
--- a/libc/docs/headers/index.rst
+++ b/libc/docs/headers/index.rst
@@ -21,6 +21,7 @@ Implementation Status
    math/index.rst
    net/if
    netinet/in
+   pwd
    search
    setjmp
    signal
diff --git a/libc/utils/docgen/pwd.yaml b/libc/utils/docgen/pwd.yaml
new file mode 100644
index 0000000000000..156a663c8c5e8
--- /dev/null
+++ b/libc/utils/docgen/pwd.yaml
@@ -0,0 +1,15 @@
+functions:
+  endpwent:
+    in-latest-posix: ''
+  getpwent:
+    in-latest-posix: ''
+  getpwnam:
+    in-latest-posix: ''
+  getpwnam_r:
+    in-latest-posix: ''
+  getpwuid:
+    in-latest-posix: ''
+  getpwuid_r:
+    in-latest-posix: ''
+  setpwent:
+    in-latest-posix: ''

@kaladron
Copy link
Copy Markdown
Contributor

Thank you! Please let me know if you need help commiting after a rebase.

Add YAML metadata for pwd.h listing all POSIX-mandated functions
(endpwent, getpwent, getpwnam, getpwnam_r, getpwuid, getpwuid_r,
setpwent). This header defines no macros per POSIX.

Add pwd to index.rst and CMakeLists.txt docgen_list.

Partial fix for llvm#122006
@kaladron kaladron enabled auto-merge (squash) May 1, 2026 13:33
@kaladron kaladron merged commit bcaaf61 into llvm:main May 1, 2026
33 checks passed
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

@kovan Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

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