aboutsummaryrefslogtreecommitdiffstats
path: root/man/man7
AgeCommit message (Collapse)AuthorFilesLines
6 daysman/man7/ip.7: Refer to sockaddr_in(3type)Alejandro Colomar1-22/+11
And improve formatting. Signed-off-by: Alejandro Colomar <alx@kernel.org>
6 daysman/man7/ip.7, man/man2const/IPPROTO_IP.2const: Split IPPROTO_IP from ip(7)Alejandro Colomar1-941/+3
Signed-off-by: Alejandro Colomar <alx@kernel.org>
7 daysman/man7/ip.7, man/man5/proc_sys_net_ipv4.5: Split /proc/sys/net/ipv4/ from ↵Alejandro Colomar1-158/+6
ip(7) Signed-off-by: Alejandro Colomar <alx@kernel.org>
13 daysman/man7/ip.7: srcfixAlejandro Colomar1-4/+7
Signed-off-by: Alejandro Colomar <alx@kernel.org>
13 daysman/man7/ip.7: Clarify IP_PKTINFO's semantics depending on packet directionJakub Głogowski1-3/+14
For recvmsg(2), ipi_spec_dst is set by ipv4_pktinfo_prepare() to the result of fib_compute_sec_dst(). The latter was introduced in linux.git 35ebf65e851c6d97 ("ipv4: Create and use fib_compute_spec_dst() helper."). Quoting its commit message: > The specific destination is the host we direct unicast replies to. > Usually this is the original packet source address, but if we are > responding to a multicast or broadcast packet we have to use something > different. > > Specifically we must use the source address we would use if we were to > send a packet to the unicast source of the original packet. Experimentation seems to confirm that behavior. As for the note about ipi_spec_dst being on a different interface: - For unicast packets (for which ipi_spec_dst is the original destination address), I believe this is trivially true because Linux uses the weak host model (unless there's some interaction with RTCF_LOCAL that I'm missing). - For multicast/broadcast packets, fib_compute_sec_dst() only passes the original interface to the lookup in the context of L3M. In particular, the original implementation (cited above) set iif and oof to 0. Also, citing linux.git e7372197e15856ec ("net/ipv4: Set oif in fib_compute_spec_dst"), > If the device is not enslaved, oif is still 0 so no affect. It doesn't seem like using an address specifically from the interface the packet was received on was ever the intention. I've also confirmed this behavior (sending a multicast packet from another machine, whose IP I've routed to a dummy interface). I'm focusing on this because that's a misconception I've had before digging into the code - the sendmsg behavior explained in the same paragraph made me think ipi_spec_dst was the (primary?) address of ipi_ifindex. I think this is worth clarifying. I've made it explicit that ipi_addr isn't used by sendmsg because that's another possible misconception. The (first) extra comma in sendmsg's ipi_spec_dst's description is meant to emphasize that it's used as the local source address _and_ for the routing table lookup, as opposed to just affecting the routing table lookup. Stylistically it might be a bit weird but idk how to convey this better. Apart from the cited commits I was referencing the linux-6.17.7 tarball. __fib_validate_source (and the comment near it) might also be of interest to people trying to figure out what "specific destinations" are, exactly. Signed-off-by: Jakub Głogowski <not@dzwdz.net> Message-ID: <fb3980b64d1c827ad59726bb30761d735396e109.1763130571.git.not@dzwdz.net> Cc: <linux-kernel@vger.kernel.org> Cc: <linux-api@vger.kernel.org> Cc: Jan Engelhardt <ej@inai.de> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-29man/man7/bpf-helpers.7: Refresh page from Linux v6.17Alejandro Colomar1-7/+18
Scripted change: $ ~/src/linux/linux/v6.17/scripts/bpf_doc.py \ | rst2man \ >man7/bpf-helpers.7; Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-29man/man7/signal.7: Mention SIGWINCH was standardized in POSIX-1.2024Collin Funk1-1/+3
Signed-off-by: Collin Funk <collin.funk1@gmail.com> Message-ID: <bae6bc16f9ab6bd3e5c30dc8e11bd83566b06a6f.1747519811.git.collin.funk1@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-29man/: Update fork(2) for POSIX.1-2024, and add references to _Fork(3)Alejandro Colomar1-13/+1
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-29man/man7/pathname.7: VERSIONS: Linux doesn't disallow new-line charactersAlejandro Colomar1-0/+5
POSIX.1-2024 encourages implementations to disallow new-line characters, but Linux doesn't follow that. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-29man/man7/tcp.7: Add TCP_SAVE_SYN and TCP_SAVED_SYNValdikSS1-4/+17
Document TCP_SAVE_SYN and TCP_SAVED_SYN options based on git commit linux.git cd8ae85299d5 (2015-05-05; "tcp: provide SYN headers for passive connections") which introduced it. Link: <https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/commit/?id=cd8ae85299d54155702a56811b2e035e63064d3d> Cc: Eric Dumazet <edumazet@google.com> Signed-off-by: ValdikSS <iam@valdikss.org.ru> Message-ID: <20251015214826.70750-1-iam@valdikss.org.ru> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-15man/man7/sched.7: SEE ALSO: Update the documentation referencesSebastian Andrzej Siewior1-6/+3
The section refers to .txt files but they have been moved/ renamed to .rst some time ago. The mentioned sched-rt-group is inconvenient as people always complained about CONFIG_RT_GROUP_SCHED. Everything that describes CFS is not wrong but the kernel the kernel switched to the Earliest Virtual Deadline First (EEVDF) scheduler. Instead of updating the file links below (and adding new ones), replace them with a link to the automatically created scheduler documetation from that folder. This also has some EEVDF bits. :) Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de> Cc: André Almeida <andrealmeid@igalia.com> Cc: Darren Hart <dvhart@infradead.org> Cc: Davidlohr Bueso <dave@stgolabs.net> Cc: Ingo Molnar <mingo@redhat.com> Cc: Juri Lelli <juri.lelli@redhat.com> Cc: Peter Zijlstra <peterz@infradead.org> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Valentin Schneider <vschneid@redhat.com> Cc: Waiman Long <longman@redhat.com> Message-ID: <20250915141305.906440-4-bigeasy@linutronix.de> [alx: ffix] Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-15man/man7/sched.7: Update the real-time sectionSebastian Andrzej Siewior1-16/+40
Update the outdated information: - The PREEMPT_RT patch is merged. The patch continues to exist (as of now) but is not mandatory. - The patch can be still downloaded but most people use the git tree these days. Add a reference to it. - CONFIG_PREEMPT_DESKTOP was never thing as far as I remember. It was always CONFIG_PREEMPT and its description referred to "low latency desktop". - Within the PREEMPT-RT patch there was a brief window which introduced PREEMPT_RT_BASE and PREEMPT_RT_FULL. I am going to ignore this. - The introduction of PREEMPT_LAZY in 6.13 moved PREEMPT_RT from a preemption model to an option. - The mentioned wiki is deprecated. Update the URL to the new one. Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de> Cc: André Almeida <andrealmeid@igalia.com> Cc: Darren Hart <dvhart@infradead.org> Cc: Davidlohr Bueso <dave@stgolabs.net> Cc: Ingo Molnar <mingo@redhat.com> Cc: Juri Lelli <juri.lelli@redhat.com> Cc: Peter Zijlstra <peterz@infradead.org> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Valentin Schneider <vschneid@redhat.com> Cc: Waiman Long <longman@redhat.com> Message-ID: <20250915141305.906440-3-bigeasy@linutronix.de> [alx: minor tweaks] Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-12man/man7/rtnetlink.7: Document metrics attributes (RTAX_*).Guillaume Nault1-1/+82
Add a brief explanation of the RTAX_* attributes that can be used in RTA_METRICS. Signed-off-by: Guillaume Nault <gnault@redhat.com> Message-ID: <67e7f52aad3d777ef1075eca902d0d235e0d3753.1759950455.git.gnault@redhat.com> [alx: ffix] Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-05man/man7/capabilities.7: Expand CAP_SYS_PTRACE to include /procJonathon Reinhart1-1/+15
CAP_SYS_PTRACE is required (via ptrace_may_access) for accessing various things in /proc, so include it in the CAP_SYS_PTRACE bullet list. Also, add a hint that other things throughout the kernel may check this via ptrace_may_access(). Signed-off-by: Jonathon Reinhart <jrreinhart@google.com> Message-ID: <20250924152313.1902586-1-jrreinhart@google.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-05man/man7/ascii.7: srcfixAlejandro Colomar1-1/+1
Use the dummy character to avoid a table entry consisting only of '=', which would be interpreted as a table delimiter. We previously had a white space, but that was worse: it is not visible in the input, and produces non-ignorable output. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-05man/: ffixAlejandro Colomar2-3/+3
Remove spaces before a tab (except in a few cases). Reported-by: "G. Branden Robinson" <branden@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-04man/man7/vdso.7: ffixAlejandro Colomar1-128/+48
Reported-by: Bjarni Ingi Gislason <bjarniig@simnet.is> Suggested-by: "G. Branden Robinson" <branden@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-09-25man/: ffix (escape dashes)Alejandro Colomar1-1/+1
Most of these have been reported by 'make lint-man-dash'. A couple of them were found manually. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-09-21man-pages.7: STYLE GUIDE: Mention UNIX for BeginnersAlejandro Colomar1-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>
2025-09-21man/: Use semantic newlinesAlejandro Colomar60-1333/+1855
And fix related issues while at it. Silence false positives with \&. Reported-by: `make lint-man-semnl` Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-09-20man/man7/rtnetlink.7: ffixGuillaume Nault1-1/+1
Add the missing dot before "br", so that the command is properly executed instead of printing a spurious "br" in the output. Fixes: ab08f6698e57 (2020-04-24; "rtnetlink.7: Minor consistency fixes") Signed-off-by: Guillaume Nault <gnault@redhat.com> Message-ID: <901f3e9f201e9dad7af3456ec7e21e738dfbd899.1758208304.git.gnault@redhat.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-09-07man/: Address diagnostic about mismatched quotesAlejandro Colomar3-16/+9
Most of these are false positives, in the sense that a line break is escaped, and the matching quote is in the next source line. However, let's remove those escaped line breaks, which make reading the source more difficult. For this, rename some parameters to be shorter, and allow some lines to go slightly past the 80-column right margin. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-09-06man/: ffixAlejandro Colomar1-5/+5
Reported-by: Helge Kreutzmann <debian@helgefjell.de> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-09-06man/: ffixAlejandro Colomar1-1/+1
Fixes: a82917ada050 (2025-03-30; "man/: srcfix (\fX => \f[X])") Reported-by: Helge Kreutzmann <debian@helgefjell.de> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-09-06man/man7/man-pages.7: Document formatting of foward declarations of function ↵Alejandro Colomar1-0/+13
parameters Reported-by: Helge Kreutzmann <debian@helgefjell.de> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-09-06man/man7/random.7: grfixElliott Hughes1-2/+2
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-29man/: wsfixAlejandro Colomar2-3/+4
These cases were found with a script: $ grep -rn -P '^[^. #][^:%#]*[a-z] *[a-z][^;=%:]*$' Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-24man/man7/environ.7: srcfixAlejandro Colomar1-1/+1
Fixes: a82917ada050 (2025-03-30; "man/: srcfix (\fX => \f[X])") Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-24man/man7/inode.7: srcfixAlejandro Colomar1-4/+4
Reported-by: `make lint-man-blank` Cc: "G. Branden Robinson" <branden@debian.org> Cc: Ingo Schwarze <schwarze@openbsd.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-23man/man7/man-pages.7: ffixAlejandro Colomar1-1/+3
Prevent splitting 'uname -m', and use italics instead of quotes. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-22man/: ffixAlejandro Colomar2-8/+4
On Fri, Aug 22, 2025 at 05:09:42PM +0200, Ingo Schwarze wrote: > > .TS > > l l l > > --- > > That's terrible style. > > Using "-" in the tbl(7) layout only makes sense when the same layout > line also contains at least one cell that receives data. > > A horizontal line that extends across the table as a whole > should *not* get its own layout line but can be specified purely > in the data section of the table. That's not only more robust, > but also results in source code that is easier to read and maintain. > > The above is not just convention, but also makes sense logically > and is related to the root cause of your earlier blank line woes. > A table line that receives no data should not be specified in the > layout because every layout line requires at least one data line, > so a layout line receiving no data is an oxymoron, and that logical > contradiction is precisely what causes the issue of needing a > blank line in the first place. > > Note that in a layout line that only contains "-" for *some* cells, > while at leat one cell receives data, the problem does not occur > because the coressponding data line(s) do contain actual data > for at least one cell, so they are not blank. Reported-by: Ingo Schwarze <schwarze@openbsd.org> Suggested-by: Ingo Schwarze <schwarze@openbsd.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-22man/man7/man-pages.7: ffixAlejandro Colomar1-1/+1
This table format specification was bogus. It specified 4 columns, but we were only using 3. Due to the commit in which that was introduced, I suspect it was just a typo that went unnoticed. Fixes: 0ab815e900ce (2021-01-06; "man-pages.7: ffix: don't fill text in tables") Reported-by: Ingo Schwarze <schwarze@openbsd.org> Suggested-by: Ingo Schwarze <schwarze@openbsd.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-20man/: EXAMPLES: Use err(3) and errc(3bsd) instead of similar macrosAlejandro Colomar1-9/+8
These functions are quite portable. And if one doesn't have them for some reason (but libbsd has been ported to many systems), one can write them easily as macros, anyway. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-19man/man7/operator.7: Add _Countof and alignofAlejandro Colomar1-1/+1
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-19man/man7/operator.7: Add compound literalAlejandro Colomar1-1/+1
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-19man/man7/operator.7: Add some primary expressions that look like operatorsAlejandro Colomar1-3/+8
This allows comparing them with the precedence of operators. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-19man/man7/cgroups.7: plfixIan1-1/+1
Signed-off-by: Ian <ilc@ilcharle.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-06-28man/: SYNOPSIS: Don't highlight forward declarations of function parametersAlejandro Colomar1-8/+8
Previously, many people confused these for actual parameters, since it's hard to distinguish a ',' from ';'. By removing bold/italics from these, it will be easier to distinguish them. The cases have been found with a script: $ find -type f \ | xargs grep -l '^\.TH ' \ | sort \ | xargs mansect SYNOPSIS \ | man /dev/stdin \ | grep -e '^[^ ]' -e '[^ ]( [^ )].*[^)];' \ | less; Reported-by: Mark Naughton <mnaughto@redhat.com> Suggested-by: Mark Harris <mark.hsj@gmail.com> Acked-by: Mark Naughton <mnaughto@redhat.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-05-17*: grfixAlejandro Colomar121-121/+121
Scripted change: $ grep -rl 'The authors of the Linux man-pages' \ | xargs sed -i '/Copyright, The authors of the Linux man-pages project/s/The/the/'; Reported-by: Josh Triplett <josh@joshtriplett.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-05-10*, AUTHORS: Consistently refer to authorsAlejandro Colomar121-121/+121
- Rename the file CREDITS => AUTHORS - Say 'authors' in the copyright notice. Scripted change: $ grep -rn 'The contributors to the Linux man-pages' -l \ | xargs sed -i '/Copyright, The contributors to the Linux man-pages project/s/contributors to/authors of/' Suggested-by: Dave Martin <Dave.Martin@arm.com> Acked-by: "G. Branden Robinson" <branden@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-05-07man/man7/bpf-helpers.7: Refresh page from Linux v6.14Alejandro Colomar1-1/+1
Scripted change: $ ~/src/linux/linux/v6.14/scripts/bpf_doc.py \ | rst2man \ >man/man7/bpf-helpers.7; Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-05-06*, CREDITS: Unify copyright noticesAlejandro Colomar121-186/+131
Link: <https://lore.kernel.org/linux-man/jpin2dbnp5vpitnh7l4qmvkamzq3h3xljzsznrudgioox3nn72@57uybxbe3h4p/T/#u> Link: <https://www.linuxfoundation.org/blog/blog/copyright-notices-in-open-source-software-projects> Cc: "G. Branden Robinson" <branden@debian.org> Cc: Carlos O'Donell <carlos@redhat.com> Cc: Eugene Syromyatnikov <evgsyr@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-05-06man/, CREDITS: Move in-source contribution records to CREDITSAlejandro Colomar70-296/+39
This information is better placed in the git logs, not in the source code itself. For people interested in the old history of pages, before we used git, they will probably look at old versions of these pages, like for example man-pages-1.70, or the 'prehistory' branch, and there they'll find these notes. Keep the names and emails of contributors in a new CREDITS file. Link: <https://lore.kernel.org/linux-man/jpin2dbnp5vpitnh7l4qmvkamzq3h3xljzsznrudgioox3nn72@57uybxbe3h4p/T/#u> Link: <https://www.linuxfoundation.org/blog/blog/copyright-notices-in-open-source-software-projects> Cc: "G. Branden Robinson" <branden@debian.org> Cc: Carlos O'Donell <carlos@redhat.com> Cc: Eugene Syromyatnikov <evgsyr@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-04-22man/man7/mctp.7: Document Linux MCTP supportJeremy Kerr2-0/+190
This change adds a brief description for the new Management Component Transport Protocol (MCTP) support added to Linux as of linux.git bc49d8169aa7 (2021-07-29; "mctp: Add MCTP base"). This is a fairly regular sockets-API implementation, so we're just describing the semantics of socket(2), bind(2), sendto(2), and recvfrom(2) for the new protocol. Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au> Message-ID: <20250417-mctp-v3-1-07fff4d26f73@codeconstruct.com.au> [alx: minor tweaks] Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-04-05man/man?/fanotify*: Document mount namespace eventsAmir Goldstein1-0/+46
Used to subscribe for notifications for when mounts are attached/detached from a mount namespace. Reviewed-by: Jan Kara <jack@suse.cz> Reviewed-by: Miklos Szeredi <mszeredi@redhat.com> Reviewed-by: Christian Brauner <brauner@kernel.org> Signed-off-by: Amir Goldstein <amir73il@gmail.com> Message-ID: <20250404104723.1709188-2-amir73il@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-04-04man/man?/fanotify*: Reorganize documentation of FAN_FS_ERRORAmir Goldstein1-3/+3
The order of FAN_FS_ERROR entry in the event section was rather arbitrary inside the group of fid info events. FAN_FS_ERROR is a special event with error info, so place its entry after the entries for fid info events and before the entries for permission events. Reduce unneeded newlines in the FAN_FS_ERROR entry. Cc: Jan Kara <jack@suse.cz> Signed-off-by: Amir Goldstein <amir73il@gmail.com> Message-ID: <20250404104723.1709188-1-amir73il@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-04-02man/man7/fanotify.7: ffixAlejandro Colomar1-7/+16
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-04-02man/man7/fanotify.7: Document FAN_RESPONSE_INFO_AUDIT_RULEAmir Goldstein1-0/+41
Document FAN_RESPONSE_INFO_AUDIT_RULE extended response info record that was added in v6.3. Cc: Jan Kara <jack@suse.cz> Cc: Richard Guy Briggs <rgb@redhat.com> Signed-off-by: Amir Goldstein <amir73il@gmail.com> Message-ID: <20250331082759.1424401-2-amir73il@gmail.com> [alx: ffix] Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-04-02man/man?/fanotify*: Document FAN_PRE_ACCESS eventAmir Goldstein1-2/+41
The new FAN_PRE_ACCESS events are created before access to a file range, to provides an opportunity for the event listener to modify the content of the object before the user can accesss it. Those events are available for group in class FAN_CLASS_PRE_CONTENT They are reported with FAN_EVENT_INFO_TYPE_RANGE info record. Signed-off-by: Amir Goldstein <amir73il@gmail.com> Message-ID: <20250330125536.1408939-1-amir73il@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-04-02man/man?/fanotify*: Document FAN_REPORT_FD_ERRORAmir Goldstein1-0/+14
This flag from v6.13 allows reporting detailed errors on failure to open a file descriptor for an event. This API was backported to LTS kernels v6.12.4 and v6.6.66. Cc: Krishna Vivek Vitta <kvitta@microsoft.com> Reviewed-by: Jan Kara <jack@suse.cz> Signed-off-by: Amir Goldstein <amir73il@gmail.com> Message-ID: <20250331133959.1436376-1-amir73il@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-03-31man/man7/fanotify.7: Document FAN_DENY_ERRNO()Amir Goldstein1-0/+22
Document FAN_DENY_ERRNO(), which was added in Linux 6.13 to report specific errors on file access. Cc: Jan Kara <jack@suse.cz> Cc: Josef Bacik <josef@toxicpanda.com> Signed-off-by: Amir Goldstein <amir73il@gmail.com> Message-ID: <20250331082759.1424401-3-amir73il@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-03-31man/man7/fanotify.7: The response field is now a bit mask instead of an enumAmir Goldstein1-1/+1
Since the introduction of the FAN_AUDIT response flag, the response field of fanotify_response is no longer an enum it is now a bitmask, so fix the wording around FAN_ALLOW and FAN_DENY. Signed-off-by: Amir Goldstein <amir73il@gmail.com> Message-ID: <20250331082759.1424401-1-amir73il@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-03-30man/man7/boot.7: wsfixAlejandro Colomar1-1/+1
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-03-30man/: srcfix (\fX => \f[X])Alejandro Colomar46-703/+1024
While doing this global change, fix other minor issues found nearby. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-03-14man/: SYNOPSIS: Use GNU forward-declarations of parameters for sizes of ↵Alejandro Colomar1-9/+17
array parameters This syntax has been proposed for standardization in N3433. Link: <https://www.open-std.org/jtc1/sc22/wg14/www/docs/n3433.pdf> Cc: Christopher Bazley <chris.bazley.wg14@gmail.com> Cc: Martin Uecker <uecker@tugraz.at> Cc: Joseph Myers <josmyers@redhat.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-03-09man/man7/ip.7: Document capabilities to use IP_TRANSPARENTMatthieu Buffet1-0/+2
CAP_NET_ADMIN has been overkill to use setsockopt(IP_TRANSPARENT) since a discussion on LKML[1] and a patch[2] in 2011. All that is left to do is to let devs know they don't need CAP_NET_ADMIN. [2] linux.git 6cc7a765c298 (2011-10-20; "net: allow CAP_NET_RAW to set socket options IP{,V6}_TRANSPARENT") Link: [1] <https://lore.kernel.org/netdev/20111020.182214.629562655202957174.davem@davemloft.net/T/> Signed-off-by: Matthieu Buffet <matthieu@buffet.re> Message-ID: <20250307222244.597006-1-matthieu@buffet.re> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-03-06man/man7/landlock.7: Document IPC scoping (Landlock ABI v6)Günther Noack1-1/+64
With this ABI version, Landlock can restrict outgoing interactions with higher-privileged Landlock domains through Abstract Unix Domain sockets and signals. Terminology: * The *IPC Scope* of a Landlock domain is that Landlock domain and its nested domains. * An *operation* (e.g., signaling, connecting to abstract UDS) is said to be *scoped within a domain* when the flag for that operation was set at ruleset creation time. This means that for the purpose of this operation, only processes within the domain's IPC scope are reachable. Link: <https://lore.kernel.org/all/20250303194510.135506-4-gnoack@google.com/> Signed-off-by: Günther Noack <gnoack@google.com> Cc: Mickaël Salaün <mic@digikod.net> Cc: Tahera Fahimi <fahimitahera@gmail.com> Cc: Tanya Agarwal <tanyaagarwal25699@gmail.com> Cc: Daniel Burgener <dburgener@linux.microsoft.com> Cc: <linux-security-module@vger.kernel.org> Message-ID: <20250303195056.136777-4-gnoack@google.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-03-05man/man7/landlock.7: Document network supportGünther Noack1-4/+14
Copy over the existing wording from kernel documentation, as it was introduced in Linux commit 51442e8d64bc (2023-10-26, "landlock: Document network support"). Landlock rules are not only about the filesystem any more and the new wording is more appropriate. Signed-off-by: Günther Noack <gnoack@google.com> Cc: Mickaël Salaün <mic@digikod.net> Cc: Tahera Fahimi <fahimitahera@gmail.com> Cc: Tanya Agarwal <tanyaagarwal25699@gmail.com> Cc: Daniel Burgener <dburgener@linux.microsoft.com> Cc: <linux-security-module@vger.kernel.org> Message-ID: <20250303195056.136777-2-gnoack@google.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-02-16man/man7/mount_namespaces.7: Fix an incorrect path in an exampleGöran Uddeborg1-1/+1
In the example showing how locked mounts in a less privileged mount namespace can not be split, first </etc/shadow> is bind mounted, then an attempt is done to unmount </mnt/dir>, which gives an error complaining that </etc/shadow> is not mounted. The unmount should also refer to </etc/shadow>. Fixes: 906ab4945cd3 (2021-08-20; "mount_namespaces.7: Rewrite locked mounts examples to use/etc/shadow") Closes: <https://bugzilla.kernel.org/show_bug.cgi?id=217709> Signed-off-by: Göran Uddeborg <goeran@uddeborg.se> Cc: Rajesh <r.pandian@gmail.com> Message-ID: <26546.13734.573762.288144@gargle.gargle.HOWL> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-02-12man/man7/bpf-helpers.7: Refresh page from Linux v6.13Alejandro Colomar1-14/+16
Scripted change: $ ~/src/linux/linux/v6.13/scripts/bpf_doc.py \ | rst2man \ >man7/bpf-helpers.7; Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-02-02man/man7/signal.7: Update definition of SIGCHLD for POSIX.1-2001Arkadiusz Drabczyk1-2/+3
This is an XSI extension supported by Linux. Link: <https://unix.stackexchange.com/q/790116/72304> Link: <https://lore.kernel.org/linux-man/Z5U0Wh_KF3Ki62Pk@comp../> Signed-off-by: Arkadiusz Drabczyk <arkadiusz@drabczyk.org> Message-ID: <20250202130331.20320-1-arkadiusz@drabczyk.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-02-02man/man7/sched.7: Mention autogroup disabled behaviorPhil Auld1-0/+5
The autogroup feature can be contolled at runtime when built into the kernel. Disabling it in this case still creates autogroups and still shows the autogroup membership for the task in /proc. The scheduler code will just not use the the autogroup task group. This can be confusing to users. Add a sentence to this effect to sched.7 to point this out. The kernel code shows how this is used. The sched_autogroup_enabled toggle is only used in one place. kernel/sched/autogroup.h: static inline struct task_group * autogroup_task_group(struct task_struct *p, struct task_group *tg) { extern unsigned int sysctl_sched_autogroup_enabled; int enabled = READ_ONCE(sysctl_sched_autogroup_enabled); if (enabled && task_wants_autogroup(p, tg)) return p->signal->autogroup->tg; return tg; } task_wants_autogroup() is in kernel/sched/autogroup.c: bool task_wants_autogroup(struct task_struct *p, struct task_group *tg) { if (tg != &root_task_group) return false; ... return true; } One can see that any group set other than root also bypasses the use of the autogroup. All of the machinery around the creation of the autogroup is not effected by the toggle. From userspace: 0 /autogroup-112 nice 0 Note, systemd based system these days is not really using autogroups at all anyway because any task in a non-root cgroup bypasses the autogroup as well. Cc: Carlos O'Donell <codonell@redhat.com> Signed-off-by: Phil Auld <pauld@redhat.com> Message-ID: <20250116143747.2366152-1-pauld@redhat.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-01-28man/man7/pathname.7: Pathnames are opaque C stringsAlejandro Colomar1-85/+2
On Mon, Jan 27, 2025 at 07:27:59PM +0100, наб wrote: > Skimming the thread: UNIX paths are sequences of non-NUL bytes. > > It is never correct to expect to be able to have a (parse, unparse) > operation pair for which unparse(parse(x)) = x for path x. > > It's obviously wrong to reject a pathname just because you dont like it. > > Thus, when displaying a path, either (a) dump it directly to the output > (the user has configured their display device to understand the paths they use), > or if that's not possible (b) setlocale(LC_ALL, "") + mbrtowc() loop > and render the result (applying usual ?/� substitutions for mbrtowc() > errors makes sense here). > > There are very few operations on paths that are actually reasonable > to do, ever; those are: appending stuff, prepending stuff > (this is just appending stuff with the arguments backwards), > and cleaving at /es; > the "stuff" better be copied whole-sale from some other path > or an unprocessed argument (or, sure, the PFCS). > > If you're getting bytes to append to a path, do that directly. > > If you're getting characters to append to a path, > then wctomb(3) is the only non-invalid solution, > since that (obviously) turns characters into bytes in the current > locale, which (ex def) is the operation desired. > > I don't understand what the UTF-32 dance is supposed to be. > > If you're recommending transcoding paths, don't. > > To re-iterate: paths are not character sequences. > They do not represent characters. > You can't meaningfully coerce them thusly without loss of precision > (this is ok to do for display! and nothing else). > If at any point you find yourself turning wchar_t -> char > you are doing something wrong; > if you find yourself doing char -> wchar_t for anything beside display > you should probably reconsider. > > This is different under Win32 of course. But that concerns us naught. Suggested-by: наб <nabijaczleweli@nabijaczleweli.xyz> Cc: Jason Yundt <jason@jasonyundt.email> Cc: Florian Weimer <fweimer@redhat.com> Cc: "G. Branden Robinson" <branden@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-01-28man/man7/pathname.7: EXAMPLES: Use a non-ASCII filenameAlejandro Colomar1-1/+1
The ASCII filename was too simple to actually show anything useful. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-01-28man/man7/pathname.7: Add file documenting pathnamesJason Yundt1-0/+159
The goal of this new manual page is to help people create programs that do the right thing even in the face of unusual paths. The information that I used to create this new manual page came from these sources: Link: <https://unix.stackexchange.com/a/39179/316181> Link: <https://sourceware.org/pipermail/libc-help/2024-August/006737.html> Link: <https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/fs/ext4/ext4.h?h=v6.12.9#n2288> Link: <man:unix(7)> Link: <https://unix.stackexchange.com/q/92426/316181> Cc: Florian Weimer <fweimer@redhat.com> Signed-off-by: Jason Yundt <jason@jasonyundt.email> Message-ID: <20250121133523.24606-1-jason@jasonyundt.email> Cc: "G. Branden Robinson" <branden@debian.org> [alx: wfix, ffix, and other tweaks] Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-01-22man/man7/unicode.7: pfixAlejandro Colomar1-1/+1
Reported-by: Wyatt Carpenter <wyattscarpenter@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-01-15man/man7/man-pages.7: Stop telling contributors to write titles in all capsJason Yundt1-2/+1
Recently, I submitted my first patch to the Linux man-pages project. In my patch, I had created a new manual page. On the manual page’s title line, I had written the title of my new page in all caps because man-pages(7) said that I should write it that way. It turns out that man-pages(7) was wrong and that the title on the title line should have matched the title in the manual page’s filename [1][2]. This commit corrects man-pages(7) so that it does not tell contributors to use all caps when writing titles on title lines. Link: [1] <https://lore.kernel.org/linux-man/rph24kz36vysoeix4qoxxxcwq3c3fskws2vmxkkgcb2lpits3f@ysm7ug66svzh/T/#mc84250a6634d7f776118879021331001cceccbe5> Link: [2] <https://lore.kernel.org/linux-man/mog6nnwzwl2dmlrec5b7l76wbxlsnklvdulok644x6o557trib@3zwtoz47r4x3/T/#mf71422d0e159210a7ca2798f2bba50a668e1410e> Message-ID: <20250114211427.160509-1-jason@jasonyundt.email> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-01-11man/man7/user_namespaces.7: tfixAlexander Stepchenko1-1/+1
Fixes: 8c74a1cea495 (2016-07-07; "user_namespaces.7: Clarify details of CAP_SYS_ADMIN and cgroup v1 mounts") Signed-off-by: Alexander Stepchenko <geochip@altlinux.org> Message-ID: <bc17315eff26eb31ecc78a2c44b89dfb077813df.1736444255.git.geochip@altlinux.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-01-04man/man7/signal.7: Don't mention that pthread API can return EINTRArkadiusz Drabczyk1-4/+0
In pthreads.7 it says: "For each of the pthreads functions that can return an error, POSIX.1-2001 specifies that the function can never fail with the error EINTR." Link: <https://lore.kernel.org/linux-man/Z3W_qgawqyEB-QrA@comp../> Cc: Florian Weimer <fweimer@redhat.com> Signed-off-by: Arkadiusz Drabczyk <arkadiusz@drabczyk.org> Message-ID: <20250103173816.6409-1-arkadiusz@drabczyk.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-12-04man/: wfixAlejandro Colomar2-2/+3
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-11-17mount_namespaces.7: Use correctly the terms "mount" and "mount point"Alejandro Colomar1-2/+3
On Sun, Nov 17, 2024 at 16:12:24 +0100, Michael Kerrisk wrote: > > A "mount" is a tuple consisting of: > * a mount ID > * a source (e.g., a device) > * a target or "mount point" (i.e. a path name) > * the ID of the parent of this mount > * other stuff (e.g., options) Reported-by: Helge Kreutzmann <debian@helgefjell.de> Cc: Jakub Wilk <jwilk@jwilk.net> Acked-by: "Michael T. Kerrisk" <mtk.manpages@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-11-17cgroups.7: grfixAlejandro Colomar1-1/+1
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-11-17man/: Terminology consistency reforms (n, size, length)Alejandro Colomar7-65/+65
Use 'length' for the lenght of a string. Use 'n' for the number of elements. Use 'size' for the number of bytes. (And in wide-character string functions, 'size' also refers to the number of wide characters.) The change is quite large, and I might have made some mistakes. But overall, this should improve consistency in use of these terms. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-11-17attributes.7: wfixAlejandro Colomar1-2/+2
Reported-by: Helge Kreutzmann <debian@helgefjell.de> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-11-13rtnetlink.7: Document struct ifa_cacheinfoAlex Henrie1-1/+18
struct ifa_cacheinfo contains the address's creation time, update time, preferred lifetime remaining, and valid lifetime remaining. Link: <https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/if_addr.h?h=v6.11#n60> Cc: <netdev@vger.kernel.org> Signed-off-by: Alex Henrie <alexhenrie24@gmail.com> Message-ID: <20241111062205.207027-1-alexhenrie24@gmail.com> Reviewed-by: Kuniyuki Iwashima <kuniyu@amazon.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-11-05fanotify_mark.2, fanotify.7: Update documentation of fanotify w.r.t fsidAmir Goldstein1-0/+11
Clarify the conditions for getting the -EXDEV and -ENODEV errors. Signed-off-by: Amir Goldstein <amir73il@gmail.com> Reviewed-by: Jan Kara <jack@suse.cz> Message-ID: <20241105144939.181820-1-amir73il@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-11-01signal.7: Better description for SIGFPEVincent Lefevre1-1/+1
SIGFPE has comment "Floating-point exception", which corresponds to the FPE acronym. But this is misleading as this signal may also be generated by an integer division by 0. Change it to "Erroneous arithmetic operation" from POSIX. Note: the GNU C Library manual says "fatal arithmetic error". Link: <https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/signal.h.html> Link: <https://www.gnu.org/software/libc/manual/html_node/Program-Error-Signals.html> Signed-off-by: Vincent Lefevre <vincent@vinc17.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-09-01console_codes.4, inode.7: srcfixG. Branden Robinson1-1/+2
Prepare for `MR` macro migration. Rewrite man page cross references inside tbl(1) text blocks to use man(7) macros instead of troff(1) font selection escape sequences. $ cat fix-man-page-refs-in-tbl-tables-1.sed # Rewrite man page cross references inside tbl(1) text blocks to use # man(7) macros instead of troff(1) font selection escape sequences. /^\.\\"/b # Case: (handled in commit 9d21f97766, 2024-07-27) # T{ # See \fBchown\fP(2) for # T} /T{$/,/^T}/s/ \\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\) /\ .BR \1 \2\ / # Case: # T{ # the map that is loaded by the utility \fBmapscrn\fP(8). # T} /T{$/,/^T}/s/ \\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\)\([^0-9a-z]\+\)$/\ .BR \1 \2\3/ # Case: # T{ # by \fBxterm\fP(1)'s \fBhpLowerleftBugCompat\fP resource). # T} /T{$/,/^T}/s/ \\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\)\([^ ]\+\) \(.*\)/\ .BR \1 \2\3\ \4/ Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20240901032603.khxdcqiqc2pxooky@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-09-01suffixes.7: srcfixG. Branden Robinson1-3/+15
Prepare for `MR` macro migration. Migrate man page cross references in table rows from using font selection escape sequences to font alternation macros to set man page cross references. These are a handful of cases that made a sed(1)-scripted migration ordering-dependent with its substitution ('s') commands. Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20240901032548.olkeoqjwpj76h42b@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-09-01namespaces.7: srcfixG. Branden Robinson1-4/+12
Use *roff requests to shut off adjustment and hyphenation for the rightmost column of the table, which uses text blocks. (In man pages, use of such requests _outside_ of tbl(1) text blocks remains discouraged by groff(1) and mandoc(1) developers.) Also break filled input lines less aggressively. Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20240901032505.ralmc2yuwd4psgos@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-09-01namespaces.7: ffixG. Branden Robinson1-0/+2
Put a paragraph break above the table to ensure separation from the preceding paragraph with the man(7) macros from groff >= 1.23 and forthcoming mandoc(1) release. Draw a horizontal rule under the column headings. Link: <https://cvsweb.bsd.lv/mandoc/man_term.c?rev=1.241&content-type=text/x-cvsweb-markup> Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20240901032453.3dmhjz7urk2saizq@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-08-31namespaces.7: ffixG. Branden Robinson1-2/+2
Prepare for `MR` macro migration. Let the table columns breathe again. Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20240831182057.u6mza33uhz55j3xd@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-08-31man/: srcfixG. Branden Robinson2-4/+4
Prepare for `MR` macro migration. Explicitly set the width of certain table columns so that they don't change or cause "can't break line" warnings from troff(1) when the rows are converted to use text blocks. Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20240831182045.kvhjjxbztnhudjga@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-08-31man/: srcfixG. Branden Robinson1-3/+9
Prepare for `MR` macro migration. Migrate table entries from using font selection escape sequences to font alternation macros to set man page cross references. This change was automatically driven by the following sed(1) script. $ cat fix-man-page-refs-in-tbl-tables-2.sed # Rewrite man page cross references on tbl(1) rows that # precede text blocks to themselves use text blocks, # and convert them to use man(7) macros # instead of troff(1) font selection escape sequences # (which cannot be done outside a text block). /^\.\\"/b /^\\fB[^\\]*\\fP([0-9][a-z]*).*T{/s/\\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\)\(.*\)/T{\ .BR \1 \2\ T}\3/ Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20240831182027.b6pduwkthk5b3tcf@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-08-29pipe.7: Document change to default pipe size when soft limit is exceededKienan Stewart1-1/+3
See Linux commit 46c4c9d1beb7f5b4cec4dd90e7728720583ee348 ("pipe: increase minimum default pipe size to 2 pages"). Cc: Alex Xu (Hello71) <alex_y_xu@yahoo.ca> Signed-off-by: Kienan Stewart <kstewart@efficios.com> Message-ID: <20240829204448.2027276-2-kstewart@efficios.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-08-29pipe.7: Reference potential lower default in "Pipe capacity" sub-sectionKienan Stewart1-0/+3
The default capacity of pipes is two pages for users exceeding the pipe-user-pages-soft limit. Before Linux 5.14, it was only one page. Signed-off-by: Kienan Stewart <kstewart@efficios.com> Message-ID: <20240829154304.2010305-2-kstewart@efficios.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-08-21epoll.7: Clarify the event distribution under edge-triggered modeAndy Pan1-1/+2
For the moment, the edge-triggered epoll generates an event for each receipt of a chunk of data, that is to say, epoll_wait() will return and tell us a monitored file descriptor is ready whenever there is a new activity on that FD since we were last informed about that FD. This is not a real _edge_ implementation for epoll, but it's been working this way for years and plenty of projects are relying on it to eliminate the overhead of one system call of read(2) per wakeup event. There are several renowned open-source projects relying on this feature for notification function (with eventfd): register eventfd with EPOLLET and avoid calling read(2) on the eventfd when there is wakeup event (eventfd being written). Examples: nginx [1], netty [2], tokio [3], libevent [4], ect. [5] These projects are widely used in today's Internet infrastructures. Thus, changing this behavior of epoll ET will fundamentally break them and cause a significant negative impact. Linux has changed it for pipe before [6], breaking some Android libraries, which had got "reverted" somehow. [7] [8] Nevertheless, the paragraph in the manual pages describing this characteristic of epoll ET seems ambiguous, I think a more explict sentence should be used to clarify it. We're improving the notification mechanism for libuv recently by exploiting this feature with eventfd, which brings us a significant performance boost. [9] Therefore, we (as well as the maintainers of nginx, netty, tokio, etc.) would have a sense of security to build an enhanced notification function based on this feature if there is a guarantee of retaining this implementation of epoll ET for the backward compatibility in the man pages. [1]: https://github.com/nginx/nginx/blob/efc6a217b92985a1ee211b6bb7337cd2f62deb90/src/event/modules/ngx_epoll_module.c#L386-L457 [2]: https://github.com/netty/netty/pull/9192 [3]: https://github.com/tokio-rs/mio/blob/309daae21ecb1d46203a7dbc0cf4c80310240cba/src/sys/unix/waker.rs#L111-L143 [4]: https://github.com/libevent/libevent/blob/525f5d0a14c9c103be750f2ca175328c25505ea4/event.c#L2597-L2614 [5]: https://github.com/libuv/libuv/pull/4400#issuecomment-2123798748 [6]: https://lkml.iu.edu/hypermail/linux/kernel/2010.1/04363.html [7]: https://github.com/torvalds/linux/commit/3a34b13a88caeb2800ab44a4918f230041b37dd9 [8]: https://github.com/torvalds/linux/commit/3b844826b6c6affa80755254da322b017358a2f4 [9]: https://github.com/libuv/libuv/pull/4400#issuecomment-2103232402 Signed-off-by: Andy Pan <i@andypan.me> Cc: <linux-api@vger.kernel.org> Cc: Michael Kerrisk <mtk.manpages@gmail.com> Message-ID: <20240801-epoll-et-desc-v5-1-7fcb9260a3b2@andypan.me> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-08-21landlock.7: Document Landlock ABI version 5 (IOCTL)Günther Noack1-3/+50
Landlock ABI 5 restricts ioctl(2) on device files. Closes: <https://github.com/landlock-lsm/linux/issues/39> Reviewed-by: Mickaël Salaün <mic@digikod.net> Signed-off-by: Günther Noack <gnoack@google.com> Message-ID: <20240723101917.90918-3-gnoack@google.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-08-21landlock.7, landlock_*.2: Document Landlock ABI version 4Günther Noack1-3/+20
Landlock ABI 4 restricts bind(2) and connect(2) on TCP port numbers. The intent is to bring the man pages mostly in line with the kernel documentation again. I intentionally did not add networking support to the usage example in landlock.7 - I feel that in the long run, we would be better advised to maintain longer example code in the kernel samples. Closes: <https://github.com/landlock-lsm/linux/issues/32> Reviewed-by: Mickaël Salaün <mic@digikod.net> Signed-off-by: Günther Noack <gnoack@google.com> Message-ID: <20240723101917.90918-2-gnoack@google.com> Co-developed-by: Konstantin Meskhidze <konstantin.meskhidze@huawei.com> Signed-off-by: Konstantin Meskhidze <konstantin.meskhidze@huawei.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-07-23man/: ffixAlejandro Colomar1-1/+1
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-07-22landlock.7, landlock_*.2: wfixGünther Noack1-2/+4
* Various wording fixes * List the same error code multiple times, if it can happen for multiple reasons. Reviewed-by: Mickaël Salaün <mic@digikod.net> Signed-off-by: Günther Noack <gnoack@google.com> Message-ID: <20240719133801.3541732-3-gnoack@google.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-07-22fanotify.7: Document changes backported to LTS kernelsChuck Lever1-1/+1
Cc: <linux-fsdevel@vger.kernel.org> Signed-off-by: Chuck Lever <chuck.lever@oracle.com> Message-ID: <20240713181548.38002-4-cel@kernel.org> Reviewed-by: Amir Goldstein <amir73il@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-28man/: ffix (Use TQ where appropriate)Alejandro Colomar5-9/+27
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-26string_copying.7: wfixAlejandro Colomar1-4/+4
Fixes: b17819960602 ("string_copying.7: wfix") Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-26string_copying.7: wfixAlejandro Colomar1-7/+7
Say 'length-bounded' instead of 'known-lenght'. Eric Blake used that term in an email, and I think it's more clear than the old one. Link: <https://lore.kernel.org/linux-man/lpqjinqeylacuismlzsnnhy7hiuv7so6dlcccnclzmmjknnlux@asvvn6j4qrl2/T/> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-21Revert "keyrings.7: ffix"Alejandro Colomar1-2/+2
This reverts commit fa2ca6f2e080a16eebd528defef9deaea6145477. The groff(1) bug that required that workaround has been fixed. Link: <https://savannah.gnu.org/bugs/?65894> Link: <https://lists.gnu.org/archive/html/groff/2024-06/msg00036.html> Cc: "G. Branden Robinson" <branden@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-17signal.7: Fix wrong mention of sigprocmaskDev Jain1-1/+1
The handler is registered with sigaction(2), not sigprocmask(2). Even if the purpose of writing sigprocmask(2) here was to mention blocked signals, the statement currently concerns the "addition" of blocked signals; signals blocked through sigprocmask(2) would already be present in the thread context of blocked signals. Fixes: e7a5700f2313 (getcontext.3, signal.7: tfix) Signed-off-by: Dev Jain <dev.jain@arm.com> Reviewed-by: Mark Brown <broonie@kernel.org> Cc: Ingo Molnar <mingo@kernel.org> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Mark Rutland <mark.rutland@arm.com> Cc: Ryan Roberts <ryan.roberts@arm.com> Cc: Suzuki Poulouse <suzuki.poulose@arm.com> Cc: Anshuman Khandual <anshuman.khandual@arm.com> Cc: <DeepakKumar.Mishra@arm.com> Cc: Aneesh Kumar K.V <aneesh.kumar@kernel.org> Cc: <linux-kernel@vger.kernel.org> Message-ID: <20240611090823.820724-3-dev.jain@arm.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-17signal.7: Clearly describe ucontext kernel dump to user spaceDev Jain1-2/+8
The set of blocked signals is updated from struct sigaction after the kernel dumps ucontext. Mention this to avoid misunderstanding. Signed-off-by: Dev Jain <dev.jain@arm.com> Cc: Ingo Molnar <mingo@kernel.org> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Mark Rutland <mark.rutland@arm.com> Cc: Ryan Roberts <ryan.roberts@arm.com> Cc: Mark Brown <broonie@kernel.org> Cc: Suzuki Poulouse <suzuki.poulose@arm.com> Cc: Anshuman Khandual <anshuman.khandual@arm.com> Cc: <DeepakKumar.Mishra@arm.com> Cc: Aneesh Kumar K.V <aneesh.kumar@kernel.org> Cc: <linux-kernel@vger.kernel.org> Message-ID: <20240611090823.820724-2-dev.jain@arm.com> [alx: semantic newlines; ffix] Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-16keyrings.7: ffixAlejandro Colomar1-2/+2
This workarounds a groff -Thtml bug. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-16keyrings.7: ffixAlejandro Colomar1-46/+43
- Move description of files to FILES section. - Use linux.git/... for Linux documentation files in SEE ALSO. - Remove old names of Linux documentation files. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-15man/: ffixAlejandro Colomar1-1/+8
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-15man/: srcfix: Use \[rs] instead of \eAlejandro Colomar25-177/+177
Scripted change: $ find man -type f \ | xargs grep -l '\\e' \ | xargs sed -i 's/\\e/\\[rs]/g'; Link: <https://lore.kernel.org/linux-man/20240611122453.qn6jyl4go4bvwkqm@illithid/> Suggested-by: "G. Branden Robinson" <branden@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-14bpf-helpers.7: Refresh pageAlejandro Colomar1-4/+4
Scripted change: $ ~/src/linux/linux/6/6.9/scripts/bpf_doc.py \ | rst2man \ >man7/bpf-helpers.7; Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-13ioctl_ns.2, ioctl_nsfs.2, man/: Move page to ioctl_nsfs.2Alejandro Colomar3-6/+6
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-13ioctl_iflags.2, FS_IOC_[GS]ETFLAGS.2const, man/: Move page to ↵Alejandro Colomar2-3/+4
FS_IOC_SETFLAGS.2const Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-13man-pages.7: Correct escaping of \~ adviceBrian Norris1-1/+2
\e[ti] renders as \[ti] -- using \[ti] in a man page will produce a literal tilde (~), not a nonbreaking space. The intention here is to recommend \~, which produces a nonbreaking space, so we need some more escaping. Apply bold formatting too, which I believe is in accordance with the advice in this section. Fixes: 36f73ba37945 ("man-pages.7: Recommend using \[..] instead of \(.. escapes") Signed-off-by: Brian Norris <briannorris@chromium.org> Message-ID: <20240613205329.3240669-1-briannorris@chromium.org> Cc: "G. Branden Robinson" <branden@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-12ioctl_eventpoll.2, EPIOC[GS]PARAMS.2const: New page describing epoll ioctl(2)Joe Damato1-0/+1
A new page is added which describes epoll fd ioctls: EPIOCSPARAMS and EPIOCGPARAMS which allow the user to control epoll-based busy polling. Also add link pages for EPIOCSPARAMS and EPIOCGPARAMS. Signed-off-by: Joe Damato <jdamato@fastly.com> Message-ID: <20240611210941.1791446-2-jdamato@fastly.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-11address_families.7: Add break-point in long URIAlejandro Colomar1-1/+1
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-05-14string_copying.7: Document strndup(3)Alejandro Colomar1-0/+42
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-05-02man/: EXAMPLES: Add missing includesAlejandro Colomar1-0/+2
Link: <https://github.com/include-what-you-use/include-what-you-use/pull/1283> Link: <https://github.com/include-what-you-use/include-what-you-use/pull/1344> Reported-by: iwyu(1) (`make lint-c-iwyu`) Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-05-02man/, share/mk/: Move man*/ to man/Alejandro Colomar169-0/+55758
This is a scripted change: $ mkdir man/; $ mv man* man/; $ ln -st . man/man*; $ find share/mk/ -type f \ | xargs grep -l '^MANDIR *:=' \ | xargs sed -i '/^MANDIR *:=/s,$,/man,'; $ find share/mk/dist/ -type f \ | xargs grep -l man \ | xargs sed -i 's,man%,man/%,g'; Link: <https://lore.kernel.org/linux-man/YxcV4h+Xn7cd6+q2@pevik/T/> Cc: Petr Vorel <pvorel@suse.cz> Cc: Jakub Wilk <jwilk@jwilk.net> Cc: Stefan Puiu <stefan.puiu@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2022-09-09Revert "src.mk, All pages: Move man* to man/"Alejandro Colomar168-54492/+0
This reverts commit 70ac1c4785fc1e158ab2349a962dba2526bf4fbc. Link: <https://lore.kernel.org/linux-man/YxcV4h+Xn7cd6+q2@pevik/T/> Reported-by: Petr Vorel <pvorel@suse.cz> Reported-by: Jakub Wilk <jwilk@jwilk.net> Cc: Stefan Puiu <stefan.puiu@gmail.com> Signed-off-by: Alex Colomar <alx.manpages@gmail.com>
2022-09-05src.mk, All pages: Move man* to man/Alejandro Colomar168-0/+54492
The root of the repository is becoming a bit overpopulated and unorganized, due to the recent addition of more mandirs, and more informative and configuration files too. Let's create a specific mandir <man/> that contains the mandirs <man[1-8]*>. Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>