mirror of https://github.com/mkerrisk/man-pages
b0b19983d9
The manual pages are already inconsistent in which headers need to be included. Right now, not all of the types used by a function have their required header included in the SYNOPSIS. If we were to add the headers required by all of the types used by functions, the SYNOPSIS would grow too much. Not only it would grow too much, but the information there would be less precise. Having system_data_types(7) document each type with all the information about required includes is much more precise, and the info is centralized so that it's much easier to maintain. So let's document only the include required for the function prototype, and also the ones required for the macros needed to call the function. <sys/types.h> only defines types, not functions or constants, so it doesn't belong to man[23] (function) pages at all. I ignore if some old systems had headers that required you to include <sys/types.h> *before* them (incomplete headers), but if so, those implementations would be broken, and those headers should probably provide some kind of warning. I hope this is not the case. [mtk: Already in 2001, POSIX.1 removed the requirement to include <sys/types.h> for many APIs, so this patch seems well past due.] Acked-by: Zack Weinberg <zackw@panix.com> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com> Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com> |
||
|---|---|---|
| man1 | ||
| man2 | ||
| man3 | ||
| man4 | ||
| man5 | ||
| man6 | ||
| man7 | ||
| man8 | ||
| scripts | ||
| CONTRIBUTING | ||
| Changes | ||
| Changes.old | ||
| MAINTAINER_NOTES | ||
| Makefile | ||
| README | ||
| man-pages-5.11.Announce | ||
| man-pages-5.11.lsm | ||
README
This package contains Linux man pages for sections 1 through 8. Some more information is given in the 'man-pages-x.y.Announce' file. Homepage ======== For information about the Linux man-pages project, see http://www.kernel.org/doc/man-pages/index.html. Bug reports and contributing ============================ If you have corrections and additions to suggest, see http://www.kernel.org/doc/man-pages/contributing.html (Although there is a mirror of this repository on GitHub, please don't report issues via the GitHub issue tracker!) For further information on contributing, see the CONTRIBUTING file. Installing and uninstalling =========================== "make install" will copy these man pages to /usr/share/man/man[1-8]. To install to a path different from /usr, use "make install prefix=/install/path". "make remove" or "make uninstall" will remove any man page in this distribution from its destination. Use with caution, and remember to use "prefix" if desired, as with the "install" target. "make" or "make all" will perform "make uninstall" followed by "make install". Copyrights ========== See the 'man-pages-x.y.Announce' file.