summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeLines
* man-pages.7: STYLE GUIDE: Mention UNIX for BeginnersufbAlejandro Colomar2023-05-17-0/+6
| | | | | | | Reported-by: Peter Xu <peterx@redhat.com> [gbr: style fixes] Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
* man*/: wfixGünther Noack2023-04-23-3/+3
| | | | | | | | | | | | | | Fix spelling of "run time", as documented in man-pages(7): - "run time" in two words when used as a noun - "run-time" with hyphen when used as an adjective There is another occurrence in bpf-helpers.7, but that content gets generated from the kernel source and should be fixed there. Signed-off-by: Günther Noack <gnoack3000@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* groff.mk, checkstyle.tmac: Remove unnecessary tmac fileAlejandro Colomar2023-04-23-18/+0
| | | | | | | | We used it for transforming groff_man(7)'s CHECKSTYLE into errors, but we already do that with grep(1). Moreover, the tmac was hiding troff(1)'s warnings. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* Makefile: Remove unused flagAlejandro Colomar2023-04-23-1/+0
| | | | | | | | We don't have a recursive make, so this flag is not used. Moreover, if ever, for some rare reason, make traverses directories, it would be good to know. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: build-pdf: Build PDF manual pagesAlejandro Colomar2023-04-23-3/+86
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: build-ps*: Build PostScript manual pagesAlejandro Colomar2023-04-23-1/+84
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: TROFFFLAGS{_MAN,_MDOC}: Include -man/-mdoc in the flags variablesAlejandro Colomar2023-04-23-2/+4
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* groff.mk: TROFFFLAGS_MAN: tfixAlejandro Colomar2023-04-23-1/+1
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: ffixAlejandro Colomar2023-04-23-2/+2
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* groff.mk: TROFFFLAGS: Remove -tAlejandro Colomar2023-04-23-2/+1
| | | | | | | That was probably a typo; it doesn't make sense to ask troff(1) to pass the tbl(1) preprocessor, since we already did. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* Makefile: help-variables: Document MANWIDTH and NROFF_OUT_DEVICEAlejandro Colomar2023-04-23-0/+2
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: Factor out device-independent groff(1) flagsAlejandro Colomar2023-04-23-29/+52
| | | | | | | Add {EXTRA_,}NROFFFLAGS (used exclusively in 'build-catman'). This refactor will allow building other formats. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* Makefile: help-variables: Document some troff(1) flags variablesAlejandro Colomar2023-04-23-1/+1
| | | | | Fixes: 3c8198d17 ("*.mk: build-catman-troff, build-catman-troff-man, build-catman-troff-mdoc: Support mdoc(7) pages") Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: build-pre*: Split device-independent preprocessing from the catman targetsAlejandro Colomar2023-04-23-27/+55
| | | | | | | To build other output formats from the same sources, let's split the generic part of the pipelines. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* install/_.mk: Make pattern rule more explicitAlejandro Colomar2023-04-23-1/+1
| | | | | | Specify $DESTDIR, so that it's more clear what this rule is about. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* dist.mk: Create directories with $INSTALLAlejandro Colomar2023-04-23-0/+5
| | | | | | | | Other directories in $builddir are created with $MKDIR, but since these should be as if installed, it makes sense to use the same command as when installing. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* */mk: mkdir -p (and install -d) are safe to useAlejandro Colomar2023-04-23-16/+5
| | | | | | | | | | | | | | | | | | | There are no race conditions, contrary to what some sources say. Previously, we had each directory depend on its parent directory, so that only a few parent-most directories would be created with parents, and all others would be created when their parents exist. That was due to FUD about TOCTOU race conditions with mkdir -p and parallel make, but it was just FUD. This patch makes it so that each directory is directly created with parents without specifying any dependency. This simplifies the makefile at some cost: calling mkdir -p so many times is a bit slower. However, it's only about 5%, so we can live with it, since we're talking about hundreds of a second for creating all the directories that this build system knows about. Reported-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: Make comment more genericAlejandro Colomar2023-04-22-20/+20
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: License consistently with GPL-3.0-or-laterAlejandro Colomar2023-04-22-39/+39
| | | | | | Also, use consistent formatting for the license and copyright. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: check-catman: Support mdoc(7) pagesAlejandro Colomar2023-04-22-2/+2
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: build-catman-troff, build-catman-troff-man, build-catman-troff-mdoc: ↵Alejandro Colomar2023-04-22-18/+39
| | | | | | | | | Support mdoc(7) pages Split the old build-catman-troff target into two subtargets; the ...-man one supports man(7) pages, while the ...-mdoc one supports mdoc(7) pages. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* catman.mk: build-catman-troff: Fail if troff(1) writes to stderrAlejandro Colomar2023-04-22-1/+2
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: lint, lint-mdoc, lint-mdoc-mandoc: Support mdoc(7) pagesAlejandro Colomar2023-04-22-19/+83
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* Makefile: Update and remove commentsAlejandro Colomar2023-04-22-5/+1
| | | | | | | | | | | | - We don't use %/. for directories anymore. - %/ targets are obviously directories; no need to say. - Don't need to document how we create directories. That should be obvious from the code. Fixes: ac288b42c ("*.mk: Remove unnecessary '.' after directory names (but keep the '/')") Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: srcfixAlejandro Colomar2023-04-22-1/+2
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: We rewrote most of the pageAlejandro Colomar2023-04-22-0/+2
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* sockaddr.3type: POSIX Issue 8 will solve strict-aliasing issues with these typesAlejandro Colomar2023-04-22-0/+8
| | | | | | | | | | | | | | | | | | | | Link: <https://austingroupbugs.net/view.php?id=1641> Reported-by: Bastien Roucariès <rouca@debian.org> Reported-by: Alejandro Colomar <alx@kernel.org> Reviewed-by: Eric Blake <eblake@redhat.com> Cc: glibc <libc-alpha@sourceware.org> Cc: GCC <gcc@gcc.gnu.org> Cc: Stefan Puiu <stefan.puiu@gmail.com> Cc: Igor Sysoev <igor@sysoev.ru> Cc: Rich Felker <dalias@libc.org> Cc: Andrew Clayton <andrew@digital-domain.net> Cc: Richard Biener <richard.guenther@gmail.com> Cc: Zack Weinberg <zack@owlfolio.org> Cc: Florian Weimer <fweimer@redhat.com> Cc: Joseph Myers <joseph@codesourcery.com> Cc: Jakub Jelinek <jakub@redhat.com> Cc: Sam James <sam@gentoo.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* build-catman.mk: Use .set suffix for troff(1) outputAlejandro Colomar2023-04-21-4/+4
| | | | | Suggested-by: Ralph Corderoy <ralph@inputplus.co.uk> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: Destandardeseify Match offsetsнаб2023-04-21-28/+25
| | | | | | | | | | | This section reads like it were (and pretty much is) lifted from POSIX. That's hard to read, because POSIX is horrendously verbose, as usual. Instead, synopsise it into something less formal but more reasonable, and describe the resulting range with a range instead of a paragraph. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: Desoupify regerror() descriptionнаб2023-04-21-20/+16
| | | | | Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: SYNOPSIS: Remove superfluous commentsAlejandro Colomar2023-04-21-6/+3
| | | | | | | | | | This has the benefit that we can use proportional-width fonts in the SYNOPSIS without misalignment in the structures. Cc: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Cc: Ralph Corderoy <ralph@inputplus.co.uk> Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: Further clarify the sole purpose of REG_NOSUBнаб2023-04-21-8/+6
| | | | | | Link: <https://lore.kernel.org/linux-man/3459b2a0-6a07-40fc-1e66-db906c3f62ac@gmail.com/T/#mb50a957359e029c611d6e0b8f1b1a20101aae670> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: Finalise move of reg*.3typeнаб2023-04-21-18/+32
| | | | | | | | | | | | | | | They're inextricably linked, not cross-referenced at all, and not used anywhere else. Now that they (realistically) exist to the reader, add a note on how big nmatch can be; POSIX even says "The application developer should note that there is probably no reason for using a value of nmatch that is larger than preg−>re_nsub+1.". Also remove the now-duplicate regmatch_t declaration. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3, regex_t.3type, regmatch_t.3type, regoff_t.3type: Move & link ↵наб2023-04-21-65/+33
| | | | | | | | | regex_t.3type into regex.3 Move-only commit. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* dl_iterate_phdr.3: EXAMPLES: Alignment should match open parenthesisAlejandro Colomar2023-04-21-14/+14
| | | | | | Reported-by: checkpatch(1) (`make lint-c-checkpatch`) Reported-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* EXIT_SUCCESS.3const: EXAMPLES: Do not use assignment in if conditionAlejandro Colomar2023-04-21-1/+2
| | | | | | Reported-by: checkpatch(1) (`make lint-c-checkpatch`) Reported-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: Desoupify regfree() descriptionнаб2023-04-21-5/+5
| | | | | Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: Improve REG_STARTENDнаб2023-04-21-13/+16
| | | | | | | | | | | | | | | | Explicitly spell out the ranges involved. The original wording always confused me, but it's actually very sane. Remove "this doesn't change R_NOTBOL & R_NEWLINE" ‒ so does it change R_NOTEOL? No. That's weird and confusing. String largeness doesn't matter, known-lengthness does. Explicitly spell out the influence on returned matches (relative to string, not start of range). Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: Desoupify regexec() descriptionнаб2023-04-21-6/+4
| | | | | Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* syscall.2: Document ENOSYS errorGünther Noack2023-04-21-0/+6
| | | | | | | Link: <https://lore.kernel.org/linux-man/31ecebc5-1b97-b610-a097-f260ec4d4c8d@gmail.com/> Suggested-by: Alejandro Colomar <alx@kernel.org> Signed-off-by: Günther Noack <gnoack3000@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: SYNOPSIS: Add _Nullable qualifier to regerror()'s errbufAlejandro Colomar2023-04-20-2/+2
| | | | | | | | Passing NULL there means that the function returns the size needed for a copy without actually copying (possibly useful before allocating a buffer large enough). Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: Desoupify regcomp() descriptionнаб2023-04-20-15/+7
| | | | | | | | | | | | | | | | | | Behold: regerror() is passed the error code, errcode, the pattern buffer, preg, a pointer to a character string buffer, errbuf, and the size of the string buffer, errbuf_size. Absolute soup. This reads to me like an ill-conceived copy from a very early standard version. It looks fine in source form but is horrific to read as running text. Instead, replace all of these with just the descriptions of what they do with their arguments. What the arguments are is very clearly noted in big bold in the prototypes. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: Fix subsection headingsнаб2023-04-20-5/+5
| | | | | Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: SYNOPSIS: Add _Nullable qualifierAlejandro Colomar2023-04-20-2/+2
| | | | | Reported-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: ffix, wfixнаб2023-04-20-7/+7
| | | | | | | | Use "bitwise OR" instead of "bitwise-or" (with fonts). No other pages spell it like this. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: wfixнаб2023-04-20-2/+2
| | | | | | | | | "Not in POSIX.2", so is it in POSIX.1-2008? POSIX.1-2001? (or any other combination of standards from this millenion not mentioned on this page?) It's not: just say POSIX. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: ffixнаб2023-04-20-2/+2
| | | | | | | We never bold POSIX, not even anywhere else on this page. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* regex.3: Note that pmatch is still used if REG_NOSUB if REG_STARTENDнаб2023-04-20-2/+4
| | | | | | | | | | | | | | In the regexec() signature regmatch_t pmatch[restrict .nmatch], is a simplification. It's actually regmatch_t pmatch[restrict ((.preg->flags & REG_NOSUB) ? 0 : .nmatch) ?: !!(.eflags & REG_STARTEND)], But speccing that would be insane. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* landlock.7: Return instead of exit() if Landlock is unusableGünther Noack2023-04-19-1/+1
| | | | | | | | | | | When following a best effort approach, we should not fail when Landlock is unusable, but we should fall back to doing nothing. Link: <https://lore.kernel.org/linux-man/5d90e3b0-1577-7efd-03b8-f94b6e50fbc1@digikod.net/> Suggested-by: Mickaël Salaün <mic@digikod.net> Signed-off-by: Günther Noack <gnoack3000@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* landlock.7: wfix: Error message wording in code exampleGünther Noack2023-04-19-1/+1
| | | | | | | Link: <https://lore.kernel.org/linux-man/5d90e3b0-1577-7efd-03b8-f94b6e50fbc1@digikod.net/> Suggested-by: Mickaël Salaün <mic@digikod.net> Signed-off-by: Günther Noack <gnoack3000@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>