summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeLines
...
* create_module.2: SYNOPSIS: Mark as [[deprecated]]Alejandro Colomar2022-09-05-4/+1
| | | | | | This syscall was removed in Linux 2.6. Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* bdflush.2: SYNOPSIS: Mark as [[deprecated]]Alejandro Colomar2022-09-05-5/+2
| | | | | | This syscal is not supported anymore by glibc, and does nothing. Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* NULL.3const: Add documentation for NULLAlejandro Colomar2022-09-05-0/+74
| | | | | | | | Reported-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Cc: Ralph Corderoy <ralph@inputplus.co.uk> Cc: Ingo Schwarze <schwarze@usta.de> Cc: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* Makefile, install-man.mk: Adapt makefiles to new 3const subsectionAlejandro Colomar2022-09-05-1/+8
| | | | Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* Various pages: SYNOPSIS: ffixAlejandro Colomar2022-09-05-30/+30
| | | | | | | | | | | Enclose struct/union definitions in EX/EE. nf/fi produces alignment issues in output devices where the font is not monospaced. EX/EE forces use of monospaced font, so it's more appropriate to format SYNOPSIS that contain structure types, where alignment is essential. Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* ioctl_console.2: document all extant TIOCLINUX subcodes as of 6.0 (2.6.17)наб2022-09-02-1/+42
| | | | | | Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Cc: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* ioctl_console.2: devices/char/console.c and sel_buffer don't exist anymoreнаб2022-09-02-2/+1
| | | | | | | | And haven't for over a decade. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Cc: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* ioctl_console.2: use symbolic subcodesнаб2022-09-02-12/+18
| | | | | | Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Cc: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* hosts.5: Use "example.org" as example domainJakub Wilk2022-09-01-3/+3
| | | | | Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* sysvipc.7: tfixŠtěpán Němec2022-09-01-1/+1
| | | | | Signed-off-by: Štěpán Němec <stepnem@gmail.com> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* ioctl_console.2: ffixнаб2022-09-01-11/+11
| | | | | | | Separate TIOCLINUX from subcode: they're separate variables Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* ioctl_ns.2, stat.2: Drop unneeded uintmax_t castsJakub Wilk2022-08-30-9/+9
| | | | | | | | major() and minor() return unsigned int, so the typecasts to uintmax_t are not needed. Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* termios.3: mention the integer types in SEE ALSOнаб2022-08-30-0/+3
| | | | | Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* cc_t.3type, speed_t.3type, tcflag_t.3type: document all togetherнаб2022-08-30-3/+13
| | | | | | | | | | | | | | speed_t and tcflag_t were both unmentioned in general Issue 7 has this to say: The <termios.h> header shall define the following data types through typedef: cc_t Used for terminal special characters. speed_t Used for terminal baud rates. tcflag_t Used for terminal modes. The above types shall be all unsigned integer types. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* lint-man.mk: Redirect groff output to stderrAlejandro Colomar2022-08-28-1/+1
| | | | | | groff(1) is being used to warn. Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* cmd.mk, lint-man.mk: Use MANWIDTH instead of a hardcoded 80Alejandro Colomar2022-08-28-3/+7
| | | | | | | | | Also need another variable set to MANWIDTH - 2, since troff needs room for two extra characters for some reason. Cc: Ralph Corderoy <ralph@inputplus.co.uk> Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* lint-man.mk: Use ascii instead of utf8Alejandro Colomar2022-08-28-1/+1
| | | | | | | | This is relevant for tables, which will now use ASCIIart, instead of pretty multi-byte characters which interfere with the calculation of the line width. Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* lint-man.mk: Use grep through its command variableAlejandro Colomar2022-08-28-1/+1
| | | | Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* lint-man.mk: Remove highlighting in a more robust wayAlejandro Colomar2022-08-28-3/+12
| | | | | | | 'grotty -c | col -bx' is more reliable, and far more readable. Suggested-by: Ralph Corderoy <ralph@inputplus.co.uk> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* lint-man.mk: Specify the output device through a variableAlejandro Colomar2022-08-28-2/+4
| | | | | Suggested-by: Ralph Corderoy <ralph@inputplus.co.uk> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* lint-man.mk: Use a pipeline instead of the groff(1) wrapperAlejandro Colomar2022-08-28-13/+25
| | | | | | | | | | This more explicitly shows how stuff really works, and allows inspecting some intermediate steps in case it may be necessary. Cc: Ralph Corderoy <ralph@inputplus.co.uk> Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com> Cc: <groff@gnu.org> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* lint-man.mk: Use UTF-8 outputAlejandro Colomar2022-08-27-1/+1
| | | | Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* man7/regex.7: change "\o'o\(ha'"to a real character "\(^o" (o circumflex)Bjarni Ingi Gislason2022-08-27-3/+3
| | | | | | | | Use real accented characters instead of producing them by overstriking the letter with the diacritic mark. Signed-off-by: Bjarni Ingi Gislason <bjarniig@vortex.is> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* lint-man.mk: Force groff(1) to use 80 columnsAlejandro Colomar2022-08-26-0/+1
| | | | | Cc: Ralph Corderoy <ralph@inputplus.co.uk> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* pthread_setname_np.3: Rename 'len' to 'size'Alejandro Colomar2022-08-26-3/+3
| | | | | | | The parameter doesn't represent a string length (strlen(3)), but a buffer size (sizeof()). Use a more proper name. Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* confstr.3: Rename 'len' to 'size'Alejandro Colomar2022-08-25-6/+6
| | | | | | | The parameter doesn't represent a string length (strlen(3)), but a buffer size (sizeof()). Use a more proper name. Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* Various pages: Fit rendered pages in 80 columnsAlejandro Colomar2022-08-25-12/+15
| | | | Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* wcswidth.3, wcwidth.3, veth.4: Fix accidents in .THAlejandro Colomar2022-08-25-3/+3
| | | | Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* lint-man.mk: Check that rendered pages don't go past 80 columnAlejandro Colomar2022-08-25-1/+4
| | | | | | | | | | | | | Until groff(1) or mandoc(1) add such a warning, this is good enough. Link: <https://lists.gnu.org/archive/html/groff/2022-08/msg00197.html> Link: <https://stackoverflow.com/a/24005600/6872717> Cc: Ingo Schwarze <schwarze@openbsd.org> Cc: Ralph Corderoy <ralph@inputplus.co.uk> Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com> Cc: Dave Kemper <saint.snit@gmail.com> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* CONTRIBUTING: Add more information about the mailing listAlejandro Colomar2022-08-25-9/+20
| | | | | | | | | | | Put the 'Mailing list' section the first one, since it's the most important, and rewrite it to be more informative (so we don't need to redirect to the website for everything). Also reorganize a little bit around that change. Reported-by: Jakub Wilk <jwilk@jwilk.net> Reported-by: NeilBrown <neilb@suse.de> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* Revert "Many pages: Document fixed-width types with ISO C naming"Alejandro Colomar2022-08-25-568/+549
| | | | | | | This reverts commit 2294974b3a1341e457edb682c08c5f4b2d14675e. Reported-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* Many pages: Document fixed-width types with ISO C namingman-pages-6.0-rc1Alejandro Colomar2022-08-24-549/+568
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Kernel __u64 and similar types are ABI-compatible, and mostly API-compatible with ISO C types. User-space programmers don't care about kernel details, and should only use libc types. Document syscalls and structures provided by the Linux kernel as if they used libc types. There's work in the kernel to remove this small API incompatibility, which is only for pointers or printf specifiers. Since I couldn't find any structure that uses pointers, there shouldn't be any issues here. Also, the only pointer I found was in a syscall parameter, but since syscall(2) doesn't check its arguments' types, we're also safe there. This patch doesn't go without controversy. Check the discussions in the links below. Found with: $ grep -rn '\b_*[su][8136][624]*\b' man* \ | grep -v -e /bpf-helpers.7 -e /proc.5 -e /epoll_event.3type -e /wcscmp.3 \ -e /crypt.3 -e /mempcpy.3 -e /memcmp.3 -e /string.3 -e /wcsncmp.3 \ -e /wcscasecmp.3 -e /wmemcmp.3 -e /strcasecmp.3 -e /bcmp.3 \ -e /bstring.3 -e /endian.3 -e /strverscmp.3 -e /wcsncasecmp.3 \ -e /strcoll.3 -e /strcmp.3 \ | tee /dev/tty \ | wc -l; Link: <https://lore.kernel.org/linux-man/20210423230609.13519-1-alx.manpages@gmail.com/T/> Link: <https://lore.kernel.org/lkml/YZvIlz7J6vOEY+Xu@yuki/T/> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com> Nacked-by: Alexei Starovoitov <ast@kernel.org> Nacked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Nacked-by: Daniel Borkmann <daniel@iogearbox.net> Acked-by: Zack Weinberg <zackw@panix.com> Cc: LKML <linux-kernel@vger.kernel.org> Cc: glibc <libc-alpha@sourceware.org> Cc: GCC <gcc-patches@gcc.gnu.org> Cc: bpf <bpf@vger.kernel.org> Cc: LTP List <ltp@lists.linux.it> Cc: Linux API <linux-api@vger.kernel.org> Cc: linux-arch <linux-arch@vger.kernel.org> Cc: David Laight <David.Laight@ACULAB.COM> Cc: Joseph Myers <joseph@codesourcery.com> Cc: Florian Weimer <fweimer@redhat.com> Cc: Daniel Borkmann <daniel@iogearbox.net> Cc: Cyril Hrubis <chrubis@suse.cz> Cc: David Howells <dhowells@redhat.com> Cc: Arnd Bergmann <arnd@arndb.de> Cc: Florian Weimer <fweimer@redhat.com> Cc: Rich Felker <dalias@libc.org> Cc: Adhemerval Zanella <adhemerval.zanella@linaro.org>
* print_encoding.sh: Remove unused scriptAlejandro Colomar2022-08-24-47/+0
| | | | | | | It considers every page as utf-8, so it doesn't provide any useful information. Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* check_unbalanced_macros.sh: This script's functionality is already covered ↵Alejandro Colomar2022-08-24-68/+0
| | | | | | by 'make lint-man' Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* _Generic.3: EXAMPLES: Use a constant expressionAlejandro Colomar2022-08-24-4/+4
| | | | Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* append_COLOPHON.sh, remove_COLOPHON.sh: Remove COLOPHON section.Alejandro Colomar2022-08-24-66/+0
| | | | | | | | | | | | | | | | Users should use their distribution's standard tools to know where a given page comes from and to know how to report a bug. That'll create a small barrier to bug reporters, but that'll hopefully help improve the quality of the reports. It'll also make the pages cleaner, by removing stuff that is obvious to those who know how to use their tools. We still keep part of the information of the COLOPHON, specifically the project name and the version, in the .TH line. Reported-by: Ingo Schwarze <schwarze@openbsd.org> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* utime.2, utimensat.2: explicitly mention ctime changing.NeilBrown2022-08-24-0/+5
| | | | | | | | | | | | utime and related calls always change the ctime. It is worth making this explicit. This is clear from the code (vfs_utimes() in fs/utimes.c always sets ATTR_CTIME) and is documented in <https://pubs.opengroup.org/onlinepubs/007904875/functions/utimes.html> Signed-off-by: NeilBrown <neilb@suse.de> Reviewed-by: Jeff Layton <jlayton@kernel.org> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* _Generic.3: intmax_t can't be intAlejandro Colomar2022-08-21-1/+0
| | | | Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* man-pages.7: Document recent changes to .THAlejandro Colomar2022-08-21-29/+6
| | | | | | | | Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com> Cc: Jakub Wilk <jwilk@jwilk.net> Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com> Cc: Ingo Schwarze <schwarze@openbsd.de> Cc: Michael Kerrisk <mtk.manpages@gmail.com>
* All pages: Remove the 5th argument to .THAlejandro Colomar2022-08-21-1093/+1093
| | | | | | | | | | | | | | | | | Now that we have the LIBRARY section, and a 4th argument that already tells that it's a page from the Linux man-pages project, the 5th argument isn't telling any information that the default value wouldn't. So let's just remove it. Scripted change: $ find man* -type f \ | xargs sed -Ei '/^.TH /s/(.TH +[^ ]+ +[^ ]+ +[^ ]+ +"[^"]+") .*/\1/' Acked-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com> Cc: Ingo Schwarze <schwarze@openbsd.de> Cc: Michael Kerrisk <mtk.manpages@gmail.com>
* dist.mk, version.mk: dist: Add version to .THAlejandro Colomar2022-08-21-4/+42
| | | | | | Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com> Cc: Ingo Schwarze <schwarze@openbsd.de> Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
* All pages: Replace the 4th argument to .TH by "Linux man-pages (unreleased)"Alejandro Colomar2022-08-21-1096/+1096
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | On 8/20/22 13:57, Alejandro Colomar wrote: > On 8/20/22 07:43, G. Branden Robinson wrote: >> >> In my opinion it would benefit readers of the Linux man-pages if the >> fourth argument to `TH` were what it is in many other man pages: an >> identifier for the name and version number of the release originating >> them. In every page it would be clear what version of the man-pages was >> being viewed. Little sophistication would be demanded of the user to >> check the Web to determine the relative age of the pages, independently >> of the modification date of the particular page. Such usage would be >> congruent with the argument's purpose in AT&T and BSD Unix, where this >> datum was "7th Edition", "System III", or "4.2 Berkeley Distribution", >> or similar. > > I thought about it in the past... That field was the only thing that > said where a function came from. If we removed GNU (or something else), > how would someone know where does the function or whatever comes from?? > > I guess that's also why the colophon was appended to the pages by > Michael. Since we couldn't use the 4th field for that, we had to have a > COLOPHON section. > > However, the addition of the LIBRARY section seems to fix this issue, > and so now we have an even more precise way to determine where a given > function comes from (including the library file name, and the linker > option). > > This gives me another argument for those who don't like to have a > LIBRARY section for libc stuff (since -lc is unnecessary), and consider > it noise. > >> >> Further, as the libc-related man pages in this project expand coverage >> to other libcs than GNU's, the alternatives to the empty string >> proferred in man-pages(7) seem less and less appropriate. > > Agree. LIBRARY seems much more appropriate for that purpose. > > And this helps remove the COLOPHON section (or at least, we don't need > to autogenerate it, since the version number now comes in .TH, and the > COLOPHON is static; so I can even move it to a smaller REPORTING BUGS > section). Scripted change: $ find man* -type f \ |xargs sed -Ei '/^.TH /s/(.TH +[^ ]+ +[^ ]+ +[^ ]+) +"[^"]*"/\1 "Linux man-pages (unreleased)"/' $ find man* -type f \ |xargs sed -Ei '/^.TH /s/(.TH +[^ ]+ +[^ ]+ +[^ ]+) +[^" ]+/\1 "Linux man-pages (unreleased)"/' $ git restore man5/tzfile.5 $ git restore man8/zdump.8 $ git restore man8/zic.8 $ git restore man7/bpf-helpers.7 Link: <https://lore.kernel.org/linux-man/20220819180323.dbsgxh5qvcjabjm6@jwilk.net/T/#u> Reported-by: Jakub Wilk <jwilk@jwilk.net> Reported-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com> Cc: Ingo Schwarze <schwarze@openbsd.de> Cc: Michael Kerrisk <mtk.manpages@gmail.com>
* _Generic.3: New page documenting _Generic()Alejandro Colomar2022-08-21-0/+60
| | | | | | | | | | | | Also add a hint of how intmax(3) and other functions using [u]intmax_t types could be better defined by ISO C, by requiring that they're implemented as type-generic macros, to avoid having problems with the ABI. Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com> Cc: JeanHeyd Meneide <wg14@soasis.org> Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com> Cc: Ingo Schwarze <schwarze@openbsd.de>
* build.mk: clean: Show some outputAlejandro Colomar2022-08-21-0/+1
| | | | Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* fanotify_init.2: srcfixAlejandro Colomar2022-08-21-1/+2
| | | | Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* fanotify_init.2: tfixJakub Wilk2022-08-21-2/+2
| | | | | Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* build-src.mk: Fix appending -Wstrict-prototypesJakub Wilk2022-08-20-1/+1
| | | | | Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* tcp.7: tfixJakub Wilk2022-08-20-1/+1
| | | | | Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* fanotify.7: tfixJakub Wilk2022-08-20-1/+1
| | | | | Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* tm.3type: tfixJakub Wilk2022-08-20-2/+2
| | | | | Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-01 12:57:18 +0000