diff options
| author | Nick Desaulniers <nickdesaulniers@users.noreply.github.com> | 2024-04-05 14:50:45 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-04-05 14:50:45 -0700 |
| commit | af34a5d382bc7cd93c620efa00dce449de252a0a (patch) | |
| tree | e97d26fbe52dad26d88e4b71f79d915fe5327e94 /libc/docs | |
| parent | fe45029dbdee6b3df2dbeaed17c9dd598ec511f2 (diff) | |
| download | llvm-af34a5d382bc7cd93c620efa00dce449de252a0a.zip llvm-af34a5d382bc7cd93c620efa00dce449de252a0a.tar.gz llvm-af34a5d382bc7cd93c620efa00dce449de252a0a.tar.bz2 | |
[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.
Diffstat (limited to 'libc/docs')
| -rw-r--r-- | libc/docs/fenv.rst | 64 | ||||
| -rw-r--r-- | libc/docs/index.rst | 1 |
2 files changed, 65 insertions, 0 deletions
diff --git a/libc/docs/fenv.rst b/libc/docs/fenv.rst new file mode 100644 index 0000000..6574fb7 --- /dev/null +++ b/libc/docs/fenv.rst @@ -0,0 +1,64 @@ +.. include:: check.rst + +fenv.h Functions +================ + +.. list-table:: + :widths: auto + :align: center + :header-rows: 1 + + * - Function + - Implemented + - Standard + * - fe_dec_getround + - + - 7.6.5.3 + * - fe_dec_setround + - + - 7.6.5.6 + * - feclearexcept + - |check| + - 7.6.4.1 + * - fegetenv + - |check| + - 7.6.6.1 + * - fegetexceptflag + - |check| + - 7.6.4.2 + * - fegetmode + - + - 7.6.5.1 + * - fegetround + - |check| + - 7.6.5.2 + * - feholdexcept + - |check| + - 7.6.6.2 + * - feraiseexcept + - |check| + - 7.6.4.3 + * - fesetenv + - |check| + - 7.6.6.3 + * - fesetexcept + - + - 7.6.4.4 + * - fesetexceptflag + - |check| + - 7.6.4.5 + * - fesetmode + - + - 7.6.5.4 + * - fesetround + - |check| + - 7.6.5.5 + * - fetestexcept + - |check| + - 7.6.4.7 + * - fetestexceptflag + - + - 7.6.4.6 + * - feupdateenv + - |check| + - 7.6.6.4 diff --git a/libc/docs/index.rst b/libc/docs/index.rst index 370fcd8..65ccb91 100644 --- a/libc/docs/index.rst +++ b/libc/docs/index.rst @@ -66,6 +66,7 @@ stages there is no ABI stability in any form. strings stdio stdbit + fenv libc_search c23 |