diff options
| author | Michael Kerrisk <mtk.manpages@gmail.com> | 2019-09-13 15:37:34 +0200 |
|---|---|---|
| committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2019-09-13 15:39:04 +0200 |
| commit | 4dfeb670df7930a76de64611fff2256df0319bf6 (patch) | |
| tree | a2236e73869f34c2f6154ce05c951376118093e3 /man7/man-pages.7 | |
| parent | 724ca69c82ac51d2f270f1e45d1ad574d9e7e69a (diff) | |
| download | man-pages-4dfeb670df7930a76de64611fff2256df0319bf6.tar.gz | |
man-pages.7: Relocate and enhance the text on semantic newlines
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Diffstat (limited to 'man7/man-pages.7')
| -rw-r--r-- | man7/man-pages.7 | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/man7/man-pages.7 b/man7/man-pages.7 index 58357cd825..819dccd979 100644 --- a/man7/man-pages.7 +++ b/man7/man-pages.7 @@ -102,10 +102,6 @@ Please limit source code line length to no more than about 75 characters wherever possible. This helps avoid line-wrapping in some mail clients when patches are submitted inline. -.PP -New sentences should be started on new lines. -This makes it easier to see the effect of patches, -which often operate at the level of individual sentences. .SS Title line The first command in a man page should be a .B TH @@ -527,7 +523,17 @@ The preferred way to write this in the source file is: (Using this format, rather than the use of "\efB...\efP()" makes it easier to write tools that parse man page source files.) .\" +.SS Use semantic newlines +In the source of a manual page, +new sentences should be started on new lines, +and long sentences should split into lines at clause breaks +(commas, semicolons, colons, and so on). +This convention, sometimes known as "semantic newlines", +makes it easier to see the effect of patches, +which often operate at the level of individual sentences or sentence clauses. +.\" .SS Formatting conventions (general) +.PP Paragraphs should be separated by suitable markers (usually either .I .PP or |