Revision tags: llvmorg-21-init, llvmorg-19.1.7, llvmorg-19.1.6 |
|
#
88bcf728 |
| 12-Dec-2024 |
Nick Desaulniers <nickdesaulniers@users.noreply.github.com> |
[libc][docs] move docgen from json to yaml (#119744)
That way it can more easily be integrated into hdrgen.
|
#
c047a5b3 |
| 12-Dec-2024 |
Nick Desaulniers <nickdesaulniers@users.noreply.github.com> |
[libc][docgen] simplify posix links (#119595)
Usually posix functions have individual doc pages, and each header has its own list of required macro definitions. Use a simpler key of "in-latest-posix
[libc][docgen] simplify posix links (#119595)
Usually posix functions have individual doc pages, and each header has its own list of required macro definitions. Use a simpler key of "in-latest-posix" to signal that the URL convention can be followed.
Add support for a "removed-in-posix-2008" key which will link to the 2004 docs for functions like bcmp, bcopy, bzero, index, and rindex from strings.h.
I don't want to add all of these links for pthreads.h, so automating this will make documenting these go much faster.
show more ...
|
#
52db9038 |
| 12-Dec-2024 |
Nick Desaulniers <ndesaulniers@google.com> |
[libc][docs] fix typo
Fixes: #119621
|
#
e17d2b58 |
| 12-Dec-2024 |
Nick Desaulniers <nickdesaulniers@users.noreply.github.com> |
[libc][docgen] support non-top-level headers (#119621)
such as arpa/inet, sys/*
|
#
a9aff440 |
| 05-Dec-2024 |
Nick Desaulniers <nickdesaulniers@users.noreply.github.com> |
[libc][docs] reorganize documentation (#118836)
This commit does a few things: * creates libc/docs/headers/ and moves all user API related headers under it. * updates paths and docgen * updates the
[libc][docs] reorganize documentation (#118836)
This commit does a few things: * creates libc/docs/headers/ and moves all user API related headers under it. * updates paths and docgen * updates the top level index to put these headers under a new "Implementation Status" tab. * rename some of the files to be foo.rst for foo.h (except strings, which is currently a mix of string.h and stdlib.h) * update the heading of some files to be in the form foo.h.
show more ...
|
#
fdb90cef |
| 05-Dec-2024 |
Nick Desaulniers <nickdesaulniers@users.noreply.github.com> |
[libc][docgen] update to POSIX.1-2024 (#118717)
The recently ratified POSIX.1-2024 is newer than POSIX.1-2017.
|
#
659834df |
| 04-Dec-2024 |
Nick Desaulniers <nickdesaulniers@users.noreply.github.com> |
docgen refresh (#118709)
- **[libc][docgen] Use Macro for macro table name** - **fix setjmp json, otherwise can't regen** - **regen all docs**
|
Revision tags: llvmorg-19.1.5, llvmorg-19.1.4, llvmorg-19.1.3, llvmorg-19.1.2, llvmorg-19.1.1, llvmorg-19.1.0, llvmorg-19.1.0-rc4, llvmorg-19.1.0-rc3, llvmorg-19.1.0-rc2, llvmorg-19.1.0-rc1, llvmorg-20-init, llvmorg-18.1.8, llvmorg-18.1.7 |
|
#
0f6c4d8b |
| 23-May-2024 |
Michael Flanders <flanders.michaelk@gmail.com> |
[libc][docs] adds macro handling, POSIX status, and validation to docgen (#89421)
docgen now lists macro implementation status in the generated rst files.
Adds POSIX definition link property to doc
[libc][docs] adds macro handling, POSIX status, and validation to docgen (#89421)
docgen now lists macro implementation status in the generated rst files.
Adds POSIX definition link property to docgen json API (`posix-definition`) and changes the `defined` property of docgen json API to `c-definition`. Now that docgen's api is getting more specified, adds validation checks to docgen to start codifying the docgen api spec.
To make sure this all looks good, I've added POSIX definition links to signal.h as a tester.
show more ...
|
Revision tags: llvmorg-18.1.6, llvmorg-18.1.5, llvmorg-18.1.4 |
|
#
2996cb79 |
| 12-Apr-2024 |
Michael Flanders <flanders.michaelk@gmail.com> |
[libc][docs] use docgen to generate stdbit rst docs (#88540)
Closes #88066.
Compared to before, the function names in the stdbit table are sorted by function name, not order-of-appearance in the st
[libc][docs] use docgen to generate stdbit rst docs (#88540)
Closes #88066.
Compared to before, the function names in the stdbit table are sorted by function name, not order-of-appearance in the standard. Since macros aren't printed by docgen.py and are still a TODO in the code, they are also not printed in the new stdbit.h docs.
Adds some checks to docgen.py for conditions that tripped me up.
Add code to docgen.py to add the include of the `|check|` rewriter, since all other generated files need it.
show more ...
|
#
7ab7e7a5 |
| 11-Apr-2024 |
Xu Zhang <simonzgx@gmail.com> |
[libc][docs] Generate docs for signal.h & optimized is_implemented func (#88028)
Fixes #87835
This patch added the documentation for the POSIX functions according to [n3096](https://www.open-std.o
[libc][docs] Generate docs for signal.h & optimized is_implemented func (#88028)
Fixes #87835
This patch added the documentation for the POSIX functions according to [n3096](https://www.open-std.org/jtc1/sc22/wg14/www/docs/n3096.pdf) Section 7.14, and gives the *docgen.py* script a more elegant *is_implemented* function.
show more ...
|
#
af34a5d3 |
| 05-Apr-2024 |
Nick Desaulniers <nickdesaulniers@users.noreply.github.com> |
[libc][docs] Introduce docgen (#87682)
This script+config should help us generate more consistent documentation wrt. what we currently support or not.
As an example usage:
$ ./libc/utils/docg
[libc][docs] Introduce docgen (#87682)
This script+config should help us generate more consistent documentation wrt. what we currently support or not.
As an example usage:
$ ./libc/utils/docgen/docgen.py fenv.h
Will spit out an RST formatted table that can be copy+pasted into our docs.
The config is not filled out entirely, but doing so and then updating our docs would be great beginner bugs for new contributors.
Having python+json generate things like docs, or headers (as imagined in https://github.com/nickdesaulniers/llvm-project/tree/hdr-gen2) is perhaps easier to work with than tablegen, and doesn't introduce a dependency on a host tool that needs to be compiled from llvm sources before building the rest of the libc. This can probably be merged with whatever we end up doing to replace libc-hdrgen.
Please use
https://llvm.org/docs/CodingStandards.html#python-version-and-source-code-formatting for keeping this file formatted.
show more ...
|