diff options
author | Carlos O'Donell <carlos@redhat.com> | 2024-10-09 18:32:26 -0400 |
---|---|---|
committer | Carlos O'Donell <carlos@redhat.com> | 2024-10-11 10:35:35 -0400 |
commit | 83a1cc3bc3d28c97d1af6c0957b11fe39fd786d8 (patch) | |
tree | 70c1605a0dd6a83c22d5b8126a481307a1a41ead /malloc/mcheck.h | |
parent | 392b3f0971764a0dff22942a0d9726a7d5cb4e0f (diff) | |
download | glibc-83a1cc3bc3d28c97d1af6c0957b11fe39fd786d8.tar.gz glibc-83a1cc3bc3d28c97d1af6c0957b11fe39fd786d8.tar.xz glibc-83a1cc3bc3d28c97d1af6c0957b11fe39fd786d8.zip |
manual: Fix and test @deftypef* function formatting
The manual contained several instances of incorrect formatting that were correct texinfo but produced incorrectly rendered manuals or incorrect behaviour from the tooling. The most important was incorrect quoting of function returns by failing to use {} to quote the return. The impact of this mistake means that 'info libc func' does not jump to the function in question but instead to the introductory page under the assumption that func doesn't exist. The function returns are now correctly quoted. The second issue was the use of a category specifier with @deftypefun which doesn't accept a category specifier. If a category specifier is required then @deftypefn needs to be used. This is corrected by changing the command to @deftypefn for such functions that used {Deprecated function} as a category. The last issue is a missing space between the function name and the arguments which results in odd function names like "epoll_wait(int" instead of "epoll_wait". This also impacts the use of 'info libc' and is corrected. We additionally remove ';' from the end of function arguments and add an 'int' return type for dprintf. Lastly we add a new test check-deftype.sh which verifies the expected formatting of @deftypefun, @deftypefunx, @deftypefn, and @deftypefnx. The new test is also run as the summary file is generated to ensure we don't generate incorrect results. The existing check-safety.sh is also run directly as a test to increase coverage since the existing tests only ran on manual install. The new tests now run as part of the standard "make check" that pre-commit CI runs and developers should run. No regressions on x86_64. HTML and PDF rendering reviewed and looks correct for all changes. Reviewed-by: H.J. Lu <hjl.tools@gmail.com>
Diffstat (limited to 'malloc/mcheck.h')
0 files changed, 0 insertions, 0 deletions