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.
наб [Mon, 29 Aug 2022 22:33:52 +0000 (00:33 +0200)]
cc_t.3type, speed_t.3type, tcflag_t.3type: document all together
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.
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.
CONTRIBUTING: Add more information about the mailing list
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.
Many pages: Document fixed-width types with ISO C naming
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.
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.
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>
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/'
All pages: Replace the 4th argument to .TH by "Linux man-pages (unreleased)"
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).
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.
Use tbl(1) instead of a magic sequence of spaces and tabs to get a
nice formatting. This fixes the following warnings:
mandoc: man7/spufs.7:748:7: WARNING: tab in filled text
mandoc: man7/spufs.7:748:14: WARNING: tab in filled text
mandoc: man7/spufs.7:748:22: WARNING: tab in filled text
mandoc: man7/spufs.7:748:32: WARNING: tab in filled text
mandoc: man7/spufs.7:748:34: WARNING: tab in filled text
Use tables to represent tables.
Use .EX/.EE to represent a code example.
Use \& to prevent .SS of being interpreted as man(7) source.
an.tmac:man7/man-pages.7:900: style: 5 leading space(s) on input line
an.tmac:man7/man-pages.7:901: style: 5 leading space(s) on input line
an.tmac:man7/man-pages.7:902: style: 5 leading space(s) on input line
an.tmac:man7/man-pages.7:903: style: 5 leading space(s) on input line
an.tmac:man7/man-pages.7:965: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:966: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:967: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:968: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:969: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:970: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:978: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:979: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:980: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:981: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:982: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:983: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:984: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:985: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:986: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:987: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:988: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:989: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:990: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:991: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:992: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:993: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:994: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:995: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:996: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:997: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:1003: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:1004: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:1005: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:1006: style: 4 leading space(s) on input line
an.tmac:man7/man-pages.7:1137: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2010: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2011: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2012: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2013: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2014: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2015: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2016: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2017: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2018: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2019: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2020: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2021: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2022: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2023: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2024: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2025: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2026: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2027: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2028: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2029: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2030: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2031: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2032: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2033: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2034: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2035: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2036: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2037: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2038: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2039: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2040: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:2041: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3332: style: 5 leading space(s) on input line
an.tmac:man5/proc.5:3333: style: 5 leading space(s) on input line
an.tmac:man5/proc.5:3334: style: 5 leading space(s) on input line
an.tmac:man5/proc.5:3335: style: 5 leading space(s) on input line
an.tmac:man5/proc.5:3336: style: 5 leading space(s) on input line
an.tmac:man5/proc.5:3337: style: 5 leading space(s) on input line
an.tmac:man5/proc.5:3338: style: 5 leading space(s) on input line
an.tmac:man5/proc.5:3339: style: 5 leading space(s) on input line
an.tmac:man5/proc.5:3340: style: 5 leading space(s) on input line
an.tmac:man5/proc.5:3341: style: 5 leading space(s) on input line
an.tmac:man5/proc.5:3342: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3343: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3344: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3345: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3346: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3347: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3348: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3349: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3350: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3351: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3352: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3353: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3354: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3355: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3357: style: 4 leading space(s) on input line
an.tmac:man5/proc.5:3359: style: 4 leading space(s) on input line
an.tmac:man4/st.4:715: style: use of deprecated macro: .HP
an.tmac:man4/st.4:721: style: use of deprecated macro: .HP
an.tmac:man4/st.4:727: style: use of deprecated macro: .HP
an.tmac:man4/st.4:730: style: use of deprecated macro: .HP
an.tmac:man4/st.4:736: style: use of deprecated macro: .HP
an.tmac:man4/st.4:739: style: use of deprecated macro: .HP
an.tmac:man4/st.4:744: style: use of deprecated macro: .HP
an.tmac:man4/st.4:749: style: use of deprecated macro: .HP
an.tmac:man4/st.4:753: style: use of deprecated macro: .HP
an.tmac:man4/st.4:756: style: use of deprecated macro: .HP
an.tmac:man4/st.4:764: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:89: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:91: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:94: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:97: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:101: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:103: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:105: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:107: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:109: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:111: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:113: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:604: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:606: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:608: style: use of deprecated macro: .HP
an.tmac:man4/console_codes.4:610: style: use of deprecated macro: .HP
projects / thirdparty / man-pages.git / log
