Skip to content

[libc][NFC] Accept doc fix #143996

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

Merged
merged 1 commit into from
Jun 12, 2025

Conversation

michaelrj-google
Copy link
Contributor

Docgen updates the docs when the config options are changed. This update
has been waiting since #143187.

Docgen updates the docs when the config options are changed. This update
has been waiting since llvm#143187.
@llvmbot llvmbot added the libc label Jun 12, 2025
@llvmbot
Copy link
Member

llvmbot commented Jun 12, 2025

@llvm/pr-subscribers-libc

Author: Michael Jones (michaelrj-google)

Changes

Docgen updates the docs when the config options are changed. This update
has been waiting since #143187.


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

1 Files Affected:

  • (modified) libc/docs/configure.rst (+1-1)
diff --git a/libc/docs/configure.rst b/libc/docs/configure.rst
index 8d53390ae19bf..109412225634f 100644
--- a/libc/docs/configure.rst
+++ b/libc/docs/configure.rst
@@ -29,7 +29,7 @@ to learn about the defaults for your platform and target.
     - ``LIBC_CONF_ENABLE_STRONG_STACK_PROTECTOR``: Enable -fstack-protector-strong to defend against stack smashing attack.
     - ``LIBC_CONF_KEEP_FRAME_POINTER``: Keep frame pointer in functions for better debugging experience.
 * **"errno" options**
-    - ``LIBC_CONF_ERRNO_MODE``: The implementation used for errno, acceptable values are LIBC_ERRNO_MODE_DEFAULT, LIBC_ERRNO_MODE_UNDEFINED, LIBC_ERRNO_MODE_THREAD_LOCAL, LIBC_ERRNO_MODE_SHARED, LIBC_ERRNO_MODE_EXTERNAL, and LIBC_ERRNO_MODE_SYSTEM.
+    - ``LIBC_CONF_ERRNO_MODE``: The implementation used for errno, acceptable values are LIBC_ERRNO_MODE_DEFAULT, LIBC_ERRNO_MODE_UNDEFINED, LIBC_ERRNO_MODE_THREAD_LOCAL, LIBC_ERRNO_MODE_SHARED, LIBC_ERRNO_MODE_EXTERNAL, LIBC_ERRNO_MODE_SYSTEM, and LIBC_ERRNO_MODE_SYSTEM_INLINE.
 * **"general" options**
     - ``LIBC_ADD_NULL_CHECKS``: Add nullptr checks in the library's implementations to some functions for which passing nullptr is undefined behavior.
 * **"math" options**

Copy link
Contributor

@uzairnawaz uzairnawaz left a comment

Choose a reason for hiding this comment

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

LGTM

@jhuber6
Copy link
Contributor

jhuber6 commented Jun 12, 2025

The fact that this happens at all is very not good.

Copy link
Contributor

@sribee8 sribee8 left a comment

Choose a reason for hiding this comment

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

LGTM

@michaelrj-google
Copy link
Contributor Author

Yeah, ideally this would land as part of the change updating the config.

@michaelrj-google michaelrj-google merged commit 70f44ec into llvm:main Jun 12, 2025
16 checks passed
@michaelrj-google michaelrj-google deleted the libcDocConfigFix branch June 12, 2025 23:49
tomtor pushed a commit to tomtor/llvm-project that referenced this pull request Jun 14, 2025
Docgen updates the docs when the config options are changed. This update
has been waiting since llvm#143187.
akuhlens pushed a commit to akuhlens/llvm-project that referenced this pull request Jun 24, 2025
Docgen updates the docs when the config options are changed. This update
has been waiting since llvm#143187.
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.

5 participants