summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeLines
* Changes: Ready for 6.04man-pages-6.04Alejandro Colomar2023-04-03-8/+67
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* difftime.3: Don't suggest redefining a reserved identifierAlejandro Colomar2023-04-03-1/+1
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* getopt.3: Remove const from argvAlejandro Colomar2023-04-03-10/+12
| | | | | | | | | It is unnecessary to let readers believe it's const. Keep it as a detail in VERSIONS, which will only be found by those who need it. It is better to believe it's non-const, and rarely will one need to know that it isn't true. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man2/: Remove repetitive documentation of [s]size_tAlejandro Colomar2023-04-03-14/+0
| | | | | | We already have an entire page for the types. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man2/, sockaddr.3type: Move text to sockaddr.3typeAlejandro Colomar2023-04-03-21/+5
| | | | | | | Move text about socklen_t to its own page, and remove repetitive references to read accept(2) (except from the type page itself). Signed-off-by: Alejandro Colomar <alx@kernel.org>
* epoll_ctl.2: ffixAlejandro Colomar2023-04-03-2/+2
| | | | | Reported-by: `make check-catman` Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: ffixAlejandro Colomar2023-04-03-51/+54
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* scripts/LinuxManBook/: Make the title consistent with the name of the projectAlejandro Colomar2023-04-02-2/+2
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: Simplify build treeAlejandro Colomar2023-04-02-32/+16
| | | | | | | Reuse $_MANDIR (.tmp/man/) for most stuff we build (with the exception of `make dist`). Signed-off-by: Alejandro Colomar <alx@kernel.org>
* verbose.mk: Fix warning from GNU Make 4.4Alejandro Colomar2023-04-02-3/+1
| | | | | | | | | | | | | | While '$(V).SILENT:' is a common idiom in make, it may be more explicit to put '.SILENT:' inside a conditional. Since we already used the conditional for something else, it's not a big change. As a nice side effect, vim now recognizes it and highlights it as a special target. With the old code, GNU Make 4.4 reported a warning about undefined variables: lib/verbose.mk:18: warning: undefined variable 'V' Signed-off-by: Alejandro Colomar <alx@kernel.org>
* landlock.7: Fix warningsAlejandro Colomar2023-04-02-1/+2
| | | | | Reported-by: `make lint check` Signed-off-by: Alejandro Colomar <alx@kernel.org>
* lint-man.mk: Fix previous commitAlejandro Colomar2023-04-02-71/+3
| | | | | | | | | I should have removed this in the previous commit, but somehow I forgot, and my initial tests didn't reveal the bug. After trying to check a specific page as a contributor would do, I noticed the problem. Fixes: aa344d4ba28c ("*.mk, CONTRIBUTING, INSTALL: lint, build, check: Reorganize some targets") Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk, CONTRIBUTING, INSTALL: lint, build, check: Reorganize some targetsAlejandro Colomar2023-04-02-87/+234
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Some targets which were under lint-* were really building cat pages, so let's call it build-catman, since it's what it is. As part of the build, it will report warnings, of course, as any other build system, so nothing really changed, except for the target names, and the path in the build tree where the cat pages (and intermediate files) are placed, which is now directly under <.tmp/man/*>. Some other targets were checking that the cat pages were correct after the build, so those targets have been moved to check-* targets. Document that contributors should run both the 'lint' and 'check' targets to check the correctness of their patches. `make all`, a.k.a. `make build`, now builds _all_ that can be built, including cat pages, and C programs. Implementation detail: $LINTMAN has been renamed, since now it's used also for things that are not linters. Call it $NONSO_MAN, since it's a list of the non-'.so' man pages, which are the ones we want to lint, build, and check. Future directions: I plan to implement 'build-html' using groff(1), which will reuse part of the build-catman pipeline. That will produce much higher quality HTML manual pages. Cc: G. Branden Robinson <g.branden.robinson@gmail.com> Cc: Elliott Hughes <enh@google.com> Cc: Oskari Pirhonen <xxc3ncoredxx@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5: NAME: Add "system information, and sysctl"наб2023-04-02-1/+1
| | | | | | | | | | procfs hosts a whole host of information about the system, as well as sysctls; proc(5) hosts a description of a lot of sysctls, and at present there's no way to find that out. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Cc: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* user_namespaces.7: Add note about PR_SET_DUMPABLE on nested usernsRodrigo Campos2023-04-01-0/+17
| | | | | | | | | | | | In order to create a nested user namespace, we need to re-set the PR_SET_DUMPABLE attribute after switching the effective UID/GID. Clarify this in the section about nested user namespaces. Having this note would have saved me some time debugging. Signed-off-by: Rodrigo Campos <rodrigo@sdfg.com.ar> Cc: Christian Brauner <brauner@kernel.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* printf.3: Fix wording for the 0 flag with given precisionVincent Lefevre2023-04-01-1/+1
| | | | | | | | When a precision is given, the 0 flag is ignored only for integer conversions, not for all numeric conversions. Signed-off-by: Vincent Lefevre <vincent@vinc17.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* prctl.2: ffixAlejandro Colomar2023-04-01-1/+1
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* mount_setattr.2: ffixPatrick Reader2023-04-01-3/+3
| | | | | Signed-off-by: Patrick Reader <_@pxeger.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5: Fix caps needed to read map_files contentsYounes Manton2023-04-01-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | imachug@yandex.ru testing CRIU noticed that the documentation for proc's map_files directory with respect to CAP_CHECKPOINT_RESTORE and namespaces appears to be wrong. The text reads: > since Linux 5.9, the reading process must have > either CAP_SYS_ADMIN or CAP_CHECKPOINT_RESTORE in the user > namespace where it resides. The reporter noted that the user actually needs the capabilities in the initial user namespace, not in the namespace the process resides in. As far as I can tell this appears to be the case. The text was introduced in 167f94b707148bcd46fe39c7d4ebfada9eed88f6 and refers to kernel commit 12886f8ab10ce6a09af1d92535d49c81aaa215a8. The code and message in the kernel commit refer to the initial user namespace. An example program and shell session verifying the existing behaviour follows: $ uname -r 5.15.0-52-generic $ ./test.sh + make rmf cc rmf.c -o rmf + sudo setcap cap_checkpoint_restore-eip ./rmf + ./rmf 19582: = Can't read map_files/ entry: Operation not permitted + sudo setcap cap_checkpoint_restore+eip ./rmf + ./rmf 19588: cap_checkpoint_restore=ep + unshare --user ./rmf 19591: cap_checkpoint_restore=ep Can't read map_files/ entry: Operation not permitted $ cat rmf.c int main(int argc, char **argv) { DIR *mfd; struct dirent *mfe; struct stat mfstat; int ret; system("getpcaps $PPID"); chdir("/proc/self/map_files"); mfd = opendir("."); do { mfe = readdir(mfd); } while (!strcmp(mfe->d_name, ".") || !strcmp(mfe->d_name, "..")); if (ret = stat(mfe->d_name, &mfstat)) perror("Can't read map_files/ entry"); closedir(mfd); return ret; } Signed-off-by: Younes Manton <younes.m@gmail.com> Cc: <imachug@yandex.ru> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* landlock.7: Document Landlock ABI v3 (file truncation; Linux 6.2)Günther Noack2023-04-01-2/+81
| | | | | | | | https://git.kernel.org/torvalds/c/299e2b1967578b1442128ba8b3e86ed3427d3651 Signed-off-by: Günther Noack <gnoack3000@gmail.com> Reviewed-by: Mickaël Salaün <mic@digikod.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* landlock.7: Document Landlock ABI v2 (file reparenting; Linux 5.19)Günther Noack2023-04-01-2/+100
| | | | | | | | | | | | | | | | | | * Add the description for LANDLOCK_ACCESS_FS_REFER, in line with recent update to the uapi headers: https://lore.kernel.org/linux-security-module/20230202204623.10345-1-gnoack3000@gmail.com/T/ * VERSIONS: Add a table of Landlock versions and their changes. Briefly talk about how to probe ABI levels and warn users about the special semantics of the LANDLOCK_ACCESS_FS_REFER right. * Add LANDLOCK_ACCESS_FS_REFER to the code example. Code review threads for the "refer" feature: * https://git.kernel.org/torvalds/c/cb44e4f061e16be65b8a16505e121490c66d30d0 * https://lore.kernel.org/all/20230221165205.4231-1-gnoack3000@gmail.com/ (documentation update) Signed-off-by: Günther Noack <gnoack3000@gmail.com> Reviewed-by: Mickaël Salaün <mic@digikod.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* symlink.7: cross-link to proc.5 for fs.protected_symlinksнаб2023-03-31-2/+6
| | | | | | | | | | | This is on by default in Debian, maybe the next reader won't spend an hour tracing the kernel Fixes: e8ff4f53ab9a7cbd ("Remove information migrated to inode(7) page") Closes: https://bugs.debian.org/1033477 Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Cc: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man3type/: tfixWu Zhenyu2023-03-31-3/+3
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* clock_getres.2: tfixJakub Wilk2023-03-31-1/+1
| | | | | Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* mknod.2: ffixJakub Wilk2023-03-31-2/+2
| | | | | Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5: Document KPF_PGTABLE for /proc/kpageflagsMarco Bonelli2023-03-31-0/+2
| | | | | | | | KPG_PGTABLE (bit 26) was introduced in Linux v4.18 (commit 1d40a5ea01d53251c23c7be541d3f4a656cfc537). Signed-off-by: Marco Bonelli <marco@mebeim.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sectionsAlejandro Colomar2023-03-30-5719/+6875
| | | | | | | | | | | | | | | | | | | | | | | | | | | | - Add a new HISTORY section that covers the history of an API, both regarding implementations and regarding old standards. This was previously covered in VERSIONS, and in some cases in STANDARDS. - Repurpose VERSIONS to cover differing implementations in _current_ systems. - STANDARDS is reduced to only cover current versions of standards. That basically means only C11 (C99 has been superseeded by C11; C17 is just a bugfix of C11, so not really a new version), and POSIX.1-2008 (*-2001 was superseeded by *-2008; *-2017 was just a bugfix for *-2008). The section also mentions for example 'Linux', 'GNU' or 'BSD' when a non-standard API is Linux- or GNU-only or if it's (de-facto) standard in the BSDs. - In some cases content that should go into one of these sections was in NOTES. Move it from there to where it corresponds. - In the SYNOPSIS, I added [[deprecated]] in some functions that I found are deprecated by the relevant standards. - A few other related changes... Cc: Oskari Pirhonen <xxc3ncoredxx@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: Replace links to <sources.redhat.com>Yedidyah Bar David2023-03-21-43/+43
| | | | | | | | | | | | | | | | | | | | | | | <sources.redhat.com/bugzilla> seems broken right now. Apparently it was replaced, quite a long time ago --based on what I can find on the net-- with <www.sourceware.org/bugzilla>, which does work. This patch was created with: $ find man* -type f \ | xargs grep -l 'sources.redhat.com/bugzilla' \ | xargs sed -i 's;http://sources.redhat.com/bugzilla/;https://www.sourceware.org/bugzilla/;g' Verified with: $ git diff | sed -n 's;^+.*\(https://www.sourceware.org/bugzilla/show_bug.cgi?id=[0-9]*\).*;\1;p' > URLs $ mkdir test $ cd test $ wget -i ../URLs Signed-off-by: Yedidyah Bar David <didi@redhat.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* CONTRIBUTING: Recommend make(1)'s -W, rather than actually touching the fileAlejandro Colomar2023-03-19-6/+6
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* timer_settime.2: SYNOPSIS: Put timer_gettime() firstAlejandro Colomar2023-03-18-1/+1
| | | | | | | This matches the order in getitimer(2), and so makes it easier to compare them. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* arc4random.3: Simplify STANDARDS; add HISTORYAlejandro Colomar2023-03-18-1/+8
| | | | | | | Data copied from libbsd's page. Reported-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* bind.2: NOTES: Remove sectionAlejandro Colomar2023-03-18-5/+0
| | | | | | 'socklen_t' now has its own manual page. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: tfixTom Schwindl2023-03-18-3/+3
| | | | | Signed-off-by: Tom Schwindl <schwindl@posteo.de> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man2/, man3/, man-pages.7: Move VERSIONS next to STANDARDSAlejandro Colomar2023-03-17-636/+636
| | | | | | | | | | | | VERSIONS and STANDARDS are closely related (and often the distinction is not so clear). Now that we're going to add another section, HISTORY, that is related to both, it makes sense to have the three together. As a curiosity, the list in man-pages(7) that detailed what each section should contain had them by accident(?) in the order that we're moving to, instead of the order that was used elsewhere. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* feature_test_macros.7: STANDARDS: Some ftm are specific to glibc, not LinuxAlejandro Colomar2023-03-17-1/+1
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* inode.7: STANDARDS: Remove bogus recommendationAlejandro Colomar2023-03-17-12/+0
| | | | | | | | | | | | | | | | | | | 'blkcnt_t' is defined in <sys/types.h>, per POSIX.1-2001, as blkcnt_t(3type) documents. Also, it doesn't need any ftm(7) to be defined, AFAICS: $ cat blkcnt_t.c #include <sys/types.h> int main(void) { blkcnt_t x; return x = 0; } $ cc -Wall -Wextra blkcnt_t.c $ Signed-off-by: Alejandro Colomar <alx@kernel.org>
* capabilities.7: ffixAlejandro Colomar2023-03-17-1/+2
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* hier.7: ffixAlejandro Colomar2023-03-17-2/+3
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* ip.7: Fix IP_MULTICAST_ALL descriptionChristoph Lameter2023-03-17-4/+1
| | | | | | | | | | | | | | | | INADDR_ANY has nothing to do with the IP_MULTICAST_ALL option. It does not matter if the interface is bound to all interfaces or a particular interface for the functionality of IP_MULTICAST_ALL. Multicast datagrams are addressed to a multicast IP address and will enter the network stack via a particular interface. The application can choose from which interface it will receive multicast data by binding the socket to an IP address. It can then use the IP_MULTICAST_ALL option to restrict the multicast groups that the IP stack will deliver via the socket. Signed-off-by: Christoph Lameter <cl@linux.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* suffixes.7: ffixAlejandro Colomar2023-03-17-1/+1
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* suffixes.7: Add .shtmlAlejandro Colomar2023-03-17-0/+1
| | | | | Link: <https://stackoverflow.com/questions/519619/what-is-the-purpose-and-uniqueness-shtml> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* arc4random.3, man-pages.7: ffixAlejandro Colomar2023-03-15-2/+2
| | | | | | Reported-by: Jakub Wilk <jwilk@jwilk.net> Cc: Tom Schwindl <schwindl@posteo.de> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* standards.7: ffixOskari Pirhonen2023-03-13-1/+1
| | | | | | | Fix indentation of the LFS entry. Signed-off-by: Oskari Pirhonen <xxc3ncoredxx@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* Revert "Many pages: Remove references to C89"Alejandro Colomar2023-03-13-89/+134
| | | | | | | | | | | | | | | | | | | | | | | | | | | This reverts commit 72b349dd8c209d7375d4d4f76e2315943d654ee9. This removal caused inconveniences to some programmers. We've agreed to keep the information about C89, since there's an easy way to keep it correct by checking against a plain-text copy of the standard itself: $ stdc89() { grep "[[:alpha:]] \**\b$1([[:alnum:]*,. ]*);" /path/to/c89-draft.txt; } $ stdc89 printf int printf(const char *format, ...); int printf(const char *format, ...); We will also do a split of the information in STANDARDS, since now it's a mix of what a proper STANDARDS section would be plus a HISTORY section commonly-found in other manual pages. C89 will go into HISTORY. Link: <https://lore.kernel.org/linux-man/b73a9636-1a17-36f3-3718-d9ca3b9293ed@gmail.com/T/> Link: <https://port70.net/~nsz/c/c89/c89-draft.txt> Reported-by: Oskari Pirhonen <xxc3ncoredxx@gmail.com> Reported-by: Matt Jolly <Matt.Jolly@footclan.ninja> Cc: Brian Inglis <Brian.Inglis@Shaw.ca> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* session-keyring.7: ffixAlejandro Colomar2023-03-12-1/+3
| | | | | | | Add a man-page reference at the first occurence of PAM. Reported-by: Helge Kreutzmann <debian@helgefjell.de> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* charsets.7: „German“ quotations are not old-style, but rather standardAlejandro Colomar2023-03-12-1/+1
| | | | | Reported-by: Helge Kreutzmann <debian@helgefjell.de> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: Fix ISO -> ISO/IEC where appropriateAlejandro Colomar2023-03-12-13/+13
| | | | | | Link: <https://www.iso.org> Reported-by: Helge Kreutzmann <debian@helgefjell.de> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* .gitignore, *.mk, README, RELEASE: Make $builddir a hidden dirAlejandro Colomar2023-03-12-6/+6
| | | | | | | Use <.tmp> instead of <tmp>. This makes it easier to ignore it in things like recursive searches. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man7/: ffixAlejandro Colomar2023-03-12-2/+2
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: Remove unnecessary '.' after directory names (but keep the '/')Alejandro Colomar2023-03-12-52/+52
| | | | | | | | | | | I used it for some reason I don't remember, probably because I did something wrong, and didn't know how to do it right. I've tried now without it, and it's working, so let's just remove it. While we don't want trailing slashes in directory variables, we want them in targets, so we can distinguish directory targets. Signed-off-by: Alejandro Colomar <alx@kernel.org>
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-01 10:52:28 +0000