Skip to content

[libc] Generate docs for setjmp.h #89542

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
Apr 23, 2024

Conversation

Rajveer100
Copy link
Member

Resolves #88065

Added macros and functions.

@llvmbot llvmbot added the libc label Apr 21, 2024
@llvmbot
Copy link
Member

llvmbot commented Apr 21, 2024

@llvm/pr-subscribers-libc

Author: Rajveer Singh Bharadwaj (Rajveer100)

Changes

Resolves #88065

Added macros and functions.


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

2 Files Affected:

  • (added) libc/docs/setjmp.rst (+16)
  • (added) libc/utils/docgen/setjmp.json (+15)
diff --git a/libc/docs/setjmp.rst b/libc/docs/setjmp.rst
new file mode 100644
index 00000000000000..d9188dfe1d5e47
--- /dev/null
+++ b/libc/docs/setjmp.rst
@@ -0,0 +1,16 @@
+.. include:: check.rst
+
+setjmp.h Functions
+==================
+
+.. list-table::
+  :widths: auto
+  :align: center
+  :header-rows: 1
+
+  * - Function
+    - Implemented
+    - Standard
+  * - longjmp
+    - |check|
+    - 7.13.2.1
diff --git a/libc/utils/docgen/setjmp.json b/libc/utils/docgen/setjmp.json
new file mode 100644
index 00000000000000..38d4af568926a2
--- /dev/null
+++ b/libc/utils/docgen/setjmp.json
@@ -0,0 +1,15 @@
+{
+  "macros": {
+    "__STDC_VERSION_SETJMP_H__": {
+      "defined": "7.13.2"
+    },
+    "setjmp": {
+      "defined": "7.13.1.1"
+    }
+  },
+  "functions": {
+    "longjmp": {
+      "defined": "7.13.2.1"
+    }
+  }
+}

@Rajveer100
Copy link
Member Author

@nickdesaulniers

@Rajveer100 Rajveer100 force-pushed the branch-for-issue-88065 branch 3 times, most recently from e9b0c94 to ef977e6 Compare April 21, 2024 13:21
@nickdesaulniers
Copy link
Member

cc @Flandini

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.

Looks like there was a build failure.

/home/runner/work/llvm-project/llvm-project/libc/docs/setjmp.rst:document isn't included in any toctree

You can verify this by building the docs-libc-html ninja target (ninja ninja docs-libc-html).

I think you need to link to it from libc/docs/index.rst.

@Rajveer100 Rajveer100 force-pushed the branch-for-issue-88065 branch from ef977e6 to 6b2e4cc Compare April 23, 2024 07:33
Copy link
Contributor

@michaelrj-google michaelrj-google left a comment

Choose a reason for hiding this comment

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

LGTM

@Rajveer100
Copy link
Member Author

Thanks for the approval @michaelrj-google! Could you land this for me?

@michaelrj-google michaelrj-google merged commit 3ae10fd into llvm:main Apr 23, 2024
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.

[libc][docs] generate docs for setjmp.h
5 participants