Skip to content

[libc][docs] generate docs for setjmp.h #88065

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

Closed
nickdesaulniers opened this issue Apr 8, 2024 · 5 comments · Fixed by #89542
Closed

[libc][docs] generate docs for setjmp.h #88065

nickdesaulniers opened this issue Apr 8, 2024 · 5 comments · Fixed by #89542
Assignees

Comments

@nickdesaulniers
Copy link
Member

nickdesaulniers commented Apr 8, 2024

Using n3096 Section 7.13, we should fill out the function list in a new file called libc/utils/docgen/setjmp.json (so that we have entries about which standard section talks about what, similar to libc/utils/docgen/fenv.json).

Then we should run ./libc/utils/docgen/docgen.py setjmp.h > libc/docs/setjmp.rst to create a page for setjmp.h.

Then we should add a link to setjmp in libc/docs/index.rst so that it's linked from libc.llvm.org (similar to fenv).

We need to add the include for |check| to be recognized.

#87835 and #87946 are recent examples

@nickdesaulniers nickdesaulniers added documentation good first issue https://github.com/llvm/llvm-project/contribute libc labels Apr 8, 2024
@llvmbot
Copy link
Member

llvmbot commented Apr 8, 2024

@llvm/issue-subscribers-libc

Author: Nick Desaulniers (nickdesaulniers)

Using [n3096](https://www.open-std.org/jtc1/sc22/wg14/www/docs/n3096.pdf) Section 7.13, we should fill out the function list in a new file called libc/utils/docgen/setjmp.json (so that we have entries about which standard section talks about what, similar to libc/utils/docgen/fenv.json).

Then we should run ./libc/utils/docgen/docgen.py setjmp.h > libc/docs/setjmp.rst to create a page for setjmp.h.

Then we should add a link to setjmp in libc/docs/index.rst so that it's linked from libc.llvm.org (similar to fenv).

We need to add the include for |check| to be recognized.

@llvmbot
Copy link
Member

llvmbot commented Apr 8, 2024

Hi!

This issue may be a good introductory issue for people new to working on LLVM. If you would like to work on this issue, your first steps are:

  1. Check that no other contributor has already been assigned to this issue. If you believe that no one is actually working on it despite an assignment, ping the person. After one week without a response, the assignee may be changed.
  2. In the comments of this issue, request for it to be assigned to you, or just create a pull request after following the steps below. Mention this issue in the description of the pull request.
  3. Fix the issue locally.
  4. Run the test suite locally. Remember that the subdirectories under test/ create fine-grained testing targets, so you can e.g. use make check-clang-ast to only run Clang's AST tests.
  5. Create a Git commit.
  6. Run git clang-format HEAD~1 to format your changes.
  7. Open a pull request to the upstream repository on GitHub. Detailed instructions can be found in GitHub's documentation. Mention this issue in the description of the pull request.

If you have any further questions about this issue, don't hesitate to ask via a comment in the thread below.

@llvmbot
Copy link
Member

llvmbot commented Apr 8, 2024

@llvm/issue-subscribers-good-first-issue

Author: Nick Desaulniers (nickdesaulniers)

Using [n3096](https://www.open-std.org/jtc1/sc22/wg14/www/docs/n3096.pdf) Section 7.13, we should fill out the function list in a new file called libc/utils/docgen/setjmp.json (so that we have entries about which standard section talks about what, similar to libc/utils/docgen/fenv.json).

Then we should run ./libc/utils/docgen/docgen.py setjmp.h > libc/docs/setjmp.rst to create a page for setjmp.h.

Then we should add a link to setjmp in libc/docs/index.rst so that it's linked from libc.llvm.org (similar to fenv).

We need to add the include for |check| to be recognized.

@Flandini
Copy link
Contributor

I'll grab this one :).

Rajveer100 added a commit to Rajveer100/llvm-project that referenced this issue Apr 21, 2024
Rajveer100 added a commit to Rajveer100/llvm-project that referenced this issue Apr 21, 2024
@nickdesaulniers
Copy link
Member Author

Sorry, I think @Rajveer100 has beaten you to the punch! @Flandini maybe you can help review #89542?

@nickdesaulniers nickdesaulniers removed the good first issue https://github.com/llvm/llvm-project/contribute label Apr 22, 2024
Rajveer100 added a commit to Rajveer100/llvm-project that referenced this issue Apr 23, 2024
michaelrj-google pushed a commit that referenced this issue Apr 23, 2024
Resolves #88065

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

Successfully merging a pull request may close this issue.

3 participants