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

[libc][docs] Add sys/resource header's implementation status #122563

Merged
merged 1 commit into from
Jan 14, 2025

Conversation

StarOne01
Copy link
Contributor

@StarOne01 StarOne01 commented Jan 11, 2025

Add sys/resource header's implementation status ( #122006 )

Changes:

  1. CMakeLists.txt: Added sys/resource to the list of documentation directories.
  2. index.rst: Included sys/resource in the documentation index.
  3. resource.yaml: Created a new YAML file for sys/resource with functions and macros which manages system resources.

This PR adds documentation support for the sys/resource header, including functions and macros as per the latest POSIX standards.

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

llvmbot commented Jan 11, 2025

@llvm/pr-subscribers-libc

Author: Prashanth (StarOne01)

Changes

Add sys/resource header's implementation status ( #122006 )

Changes:

  1. CMakeLists.txt: Added sys/resource to the list of documentation directories.
  2. index.rst: Included sys/resource in the documentation index.
  3. resource.yaml: Created a new YAML file for sys/resource with functions and macros which manages system resources.

This PR adds documentation support for the sys/resource header, including functions and macros as per the latest POSIX standards.


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

3 Files Affected:

  • (modified) libc/docs/CMakeLists.txt (+1)
  • (modified) libc/docs/headers/index.rst (+1)
  • (added) libc/utils/docgen/sys/resource.yaml (+43)
diff --git a/libc/docs/CMakeLists.txt b/libc/docs/CMakeLists.txt
index 4fa621fb2a0510..8548e88c73fa54 100644
--- a/libc/docs/CMakeLists.txt
+++ b/libc/docs/CMakeLists.txt
@@ -53,6 +53,7 @@ if (SPHINX_FOUND)
       string
       strings
       sys/mman
+      sys/resource
       threads
       uchar
       wchar
diff --git a/libc/docs/headers/index.rst b/libc/docs/headers/index.rst
index 2295a8cc8853cd..614fb6c703e5e7 100644
--- a/libc/docs/headers/index.rst
+++ b/libc/docs/headers/index.rst
@@ -26,6 +26,7 @@ Implementation Status
    string
    strings
    sys/mman
+   sys/resource
    threads
    time
    uchar
diff --git a/libc/utils/docgen/sys/resource.yaml b/libc/utils/docgen/sys/resource.yaml
new file mode 100644
index 00000000000000..0b8ac219853267
--- /dev/null
+++ b/libc/utils/docgen/sys/resource.yaml
@@ -0,0 +1,43 @@
+functions:
+  getpriority:
+    in-latest-posix: ''
+  getrlimit:
+    in-latest-posix: ''
+  getrusage:
+    in-latest-posix: ''
+  setpriority:
+    in-latest-posix: ''
+  setrlimit:
+    in-latest-posix: ''
+
+macros:
+  PRIO_PROCESS:
+    in-latest-posix: ''
+  PRIO_PGRP:
+    in-latest-posix: ''
+  PRIO_USER:
+    in-latest-posix: ''
+  RLIM_INFINITY:
+    in-latest-posix: ''
+  RLIM_SAVED_MAX:
+    in-latest-posix: ''
+  RLIM_SAVED_CUR:
+    in-latest-posix: ''
+  RLIMIT_CORE:
+    in-latest-posix: ''
+  RLIMIT_CPU:
+    in-latest-posix: ''
+  RLIMIT_DATA:
+    in-latest-posix: ''
+  RLIMIT_FSIZE:
+    in-latest-posix: ''
+  RLIMIT_NOFILE:
+    in-latest-posix: ''
+  RLIMIT_STACK:
+    in-latest-posix: ''
+  RLIMIT_AS:
+    in-latest-posix: ''
+  RUSAGE_SELF:
+    in-latest-posix: ''
+  RUSAGE_CHILDREN:
+    in-latest-posix: ''
\ No newline at end of file

@nickdesaulniers nickdesaulniers self-requested a review January 14, 2025 16:42
@nickdesaulniers nickdesaulniers merged commit c2771ca into llvm:main Jan 14, 2025
14 checks passed
@nickdesaulniers
Copy link
Member

thanks for the patch!

@StarOne01 StarOne01 deleted the sys_resources_doc branch January 15, 2025 15:56
paulhuggett pushed a commit to paulhuggett/llvm-project that referenced this pull request Jan 16, 2025
…2563)

### Add sys/resource header's implementation status ( llvm#122006 )

#### Changes:
1. **CMakeLists.txt**: Added `sys/resource` to the list of documentation
directories.
2. **index.rst**: Included `sys/resource` in the documentation index.
3. **resource.yaml**: Created a new YAML file for `sys/resource` with
functions and macros which manages system resources.

This PR adds documentation support for the `sys/resource` header,
including functions and macros as per the latest POSIX standards.
DKLoehr pushed a commit to DKLoehr/llvm-project that referenced this pull request Jan 17, 2025
…2563)

### Add sys/resource header's implementation status ( llvm#122006 )

#### Changes:
1. **CMakeLists.txt**: Added `sys/resource` to the list of documentation
directories.
2. **index.rst**: Included `sys/resource` in the documentation index.
3. **resource.yaml**: Created a new YAML file for `sys/resource` with
functions and macros which manages system resources.

This PR adds documentation support for the `sys/resource` header,
including functions and macros as per the latest POSIX standards.
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