1
0
mirror of git://sourceware.org/git/lvm2.git synced 2025-03-11 20:58:50 +03:00
Bjarni Ingi Gislason bb458e9528 man: remarks and editorial changes for dmstats
Use "groff -e ' $' -e '\\~$' <file>" to find obvious trailing spaces.
Use "mandoc -T lint  dmstats.8"
Use "test-groff -mandoc -t -ww -z dmstats.8"

-.-.

Lines containing '\c' (' \c' does not make sense):

503:.B \-\-units \c

-.-

Change '-' (\-) to '\(en' (en-dash) for a (numeric) range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.

dmstats.8:470:expressed as a hyphen separated range, for example: '1\-10'.

-.-.

Add a (no-break, "\ " or "\~") space between a number and a unit,
as these are not one entity.

1114:Create a 32M region 1G into device d0

-.-.

Add a "\&" after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.

511:Can also specify custom units e.g. \fB\-\-units\ 3M\fP.

-.-.

Wrong distance between sentences in the input file.

  Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").

  The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.

Remember coding: Only one command ("sentence") on each (logical) line.

-.-.

The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).

798:extents). This currently includes \fBxfs(5)\fP and \fBext4(5)\fP.
801:group, and the group alias is set to the \fBbasename(3)\fP of the

-.-.

Use thousand markers to make large numbers easy to read

560:is equivalent to 10000000. Latency values with a precision of less than

-.-.

Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.

1:.TH DMSTATS 8 "Jun 23 2016" "Linux" "MAINTENANCE COMMANDS"

-.-.

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":

.-.

Additionally:

  Fix some arguments for '.TP'.  A single-font macro does not work with
'\c', so use a two-font macro.

-.-

  Use the pair ".na / .ad" to set no-adjustment (same result as '.ad l')
and '.ad' to restore previous adjustment.
[Replacing ".ad l" ... ".ad b"]

  Set singular '.ad b' to '.ad \*(AD' as the user should have the choice to
control the adjustment from the command line.

  Add an empty string to string 'AD' with '.as AD "\"' to avoid a warning
about an undefined string.

-.-

Generally:

Split (sometimes) lines after a punctuation mark; before a conjunction.

Updated-by: zkabelac@redhat.com
2025-02-24 18:59:58 +01:00
..
2021-04-19 14:54:37 +02:00
2021-04-14 11:04:04 +02:00
2024-08-30 16:51:15 +02:00
2024-08-30 16:51:15 +02:00
2021-04-23 23:00:55 +02:00
2021-04-19 14:54:37 +02:00
2024-11-22 14:25:54 +01:00
2024-08-09 16:34:22 +02:00
2021-04-19 14:54:37 +02:00
2023-07-10 17:13:32 +02:00
2024-08-09 16:34:22 +02:00
2021-04-19 14:54:37 +02:00
2024-12-06 17:23:01 +01:00
2021-04-19 14:54:37 +02:00
2021-04-23 23:00:55 +02:00
2024-08-30 16:51:15 +02:00
2024-12-06 17:23:01 +01:00
2021-04-19 14:54:37 +02:00
2022-05-18 18:15:30 +02:00
2025-02-13 12:21:51 -06:00
2021-04-14 11:04:04 +02:00
2024-08-30 16:51:15 +02:00
2024-08-30 16:51:15 +02:00
2021-04-19 14:54:37 +02:00
2024-09-30 15:00:03 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2024-06-27 13:29:03 -05:00
2021-04-19 14:54:37 +02:00
2025-01-09 00:20:19 +01:00
2024-08-30 16:51:15 +02:00
2021-04-14 11:04:04 +02:00
2021-04-14 11:04:04 +02:00
2025-01-09 00:20:19 +01:00
2024-09-26 16:25:12 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2021-04-23 23:00:55 +02:00
2024-05-02 13:18:08 +02:00
2023-12-05 09:08:24 -06:00
2024-12-06 17:23:01 +01:00
2024-09-30 15:00:03 +02:00
2024-11-06 12:33:24 +01:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2022-08-11 11:10:11 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2022-05-18 18:15:30 +02:00
2025-01-09 00:20:19 +01:00
2022-07-11 01:18:24 +02:00
2025-01-09 00:20:19 +01:00
2021-04-19 14:54:37 +02:00
2024-12-06 17:23:01 +01:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2022-08-11 11:10:11 +02:00
2021-04-19 14:54:37 +02:00
2022-08-11 11:10:11 +02:00
2021-04-19 14:54:37 +02:00
2024-12-06 17:23:01 +01:00
2021-11-29 11:10:02 -06:00
2023-11-21 14:22:35 +01:00
2023-07-10 17:13:33 +02:00
2021-04-19 14:54:37 +02:00
2024-09-30 15:00:03 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2024-09-30 15:00:03 +02:00
2022-08-11 11:10:11 +02:00
2018-06-13 14:14:03 -05:00
2022-08-11 11:10:11 +02:00
2024-08-30 16:51:15 +02:00
2021-04-19 14:54:37 +02:00
2024-08-30 16:51:15 +02:00
2021-04-19 14:54:37 +02:00
2024-12-19 14:55:56 +01:00
2021-04-19 14:54:37 +02:00
2022-08-11 11:10:11 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2022-08-11 11:10:11 +02:00
2021-04-19 14:54:37 +02:00
2022-08-11 11:10:11 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2022-05-18 18:15:30 +02:00
2021-04-19 14:54:37 +02:00
2024-05-28 14:55:53 +02:00
2021-04-19 14:54:37 +02:00
2022-05-18 18:15:30 +02:00
2024-08-22 14:47:29 +02:00
2022-08-11 11:10:11 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2021-04-19 14:54:37 +02:00
2022-08-11 11:10:11 +02:00
2021-04-19 14:54:37 +02:00
2024-12-06 17:23:01 +01:00
2024-08-22 14:47:29 +02:00
2021-04-19 14:54:37 +02:00
2022-05-18 18:15:30 +02:00