Jump to conversation
Unresolved conversations (2)
@nickdesaulniers nickdesaulniers Apr 8, 2024
Elegant. Last week I was wondering about this since we have some cases where the subdir is a target ISA like x86_64, aarch64, etc. (i.e. `src/math/`, and other cases we have an OS like linux, darwin, windows (i.e. `src/__support/OSUtil`). I guess src/__support/OSUtil and src/sys are cases where we'd need to recurse deeper. But for now, I'm happy with this addition. It makes sense to retain the TODO at the top of this function since we'll probably be revisiting this imminently.
Outdated
libc/utils/docgen/docgen.py
simonzgx
@nickdesaulniers nickdesaulniers Apr 8, 2024
So I was thinking about these POSIX defined functions (none of this needs to be solved in this PR, but is perhaps worth thinking about how we can do something better for POSIX functions in the future). It is possible to create a hyperlink to a page about them, example: https://pubs.opengroup.org/onlinepubs/009604499/functions/kill.html Perhaps we either add more specialized handling of the 'defined' field to support URLs, or use a different field. IDK yet.
libc/utils/docgen/signal.json
Resolved conversations (4)
@nickdesaulniers nickdesaulniers Apr 8, 2024
You're going to need an include akin to e127997155a1cd1c5692c42aad074064c8dad099 else we'll break the build again. Run `ninja docs-libc-html` to build the docs and verify the build isn't broken. You'll probably need to configure llvm-libc with `-DLLVM_ENABLE_SPHINX=ON -DLIBC_INCLUDE_DOCS=ON` cmake options for that `ninja` target to be recognized.
libc/docs/signal.rst
@nickdesaulniers nickdesaulniers Apr 8, 2024
Is it possible to `glob(f"**/{source_file_name}"` and then see if that's empty or not?
Outdated
libc/utils/docgen/docgen.py
@nickdesaulniers nickdesaulniers Apr 8, 2024
please add a newline to the end of the file
Outdated
libc/utils/docgen/signal.json
@nickdesaulniers nickdesaulniers Apr 8, 2024
7.14 also mentions a few addition macros: - `SIG_DFL` - `SIG_ERR` - `SIG_IGN` and a few more. I actually find section `B.13 Signal handling <signal.h>` easier to view a concise summary of what's expected to be found where (though in n3096 it lacks a mention of `__STDC_VERSION_FENV_H__` which seems like a minor mistake in the spec). Please add those, too, even if we aren't generating documentation for them yet today.
Outdated
libc/utils/docgen/signal.json
simonzgx