diff options
| author |   Ingo Schwarze <schwarze@openbsd.org> | 2017-01-28 23:30:08 +0000 |
|---|---|---|
| committer | Ingo Schwarze <schwarze@openbsd.org> | 2017-01-28 23:30:08 +0000 |
| commit | 5a526843b7a81102e56a684b368893853ed01ee7 (patch) | |
| tree | a3053105d9025b04fa81459d08c12a275c0f98c2 /mandoc.1 | |
| parent | 0ead4d49fc7173eede03a8a404e8a08c88072f08 (diff) | |
| download | mandoc-5a526843b7a81102e56a684b368893853ed01ee7.tar.gz mandoc-5a526843b7a81102e56a684b368893853ed01ee7.tar.zst mandoc-5a526843b7a81102e56a684b368893853ed01ee7.zip | |
Add a warning "new sentence, new line".
This does not attempt to pinpoint each and every offender, but
instead tries very hard to avoid false positives: Currently, there
are only two false positives in the whole OpenBSD base system.
Only do this in mdoc(7), not in man(7), because manuals written
in man(7) typically have much worse problems than this.
OK jmc@ on a previous version of the patch
Diffstat (limited to 'mandoc.1')
| -rw-r--r-- | mandoc.1 | 8 |
1 files changed, 6 insertions, 2 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.171 2017/01/21 02:32:39 schwarze Exp $ +.\" $Id: mandoc.1,v 1.172 2017/01/28 23:30:08 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> .\" Copyright (c) 2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org> @@ -15,7 +15,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: January 21 2017 $ +.Dd $Mdocdate: January 28 2017 $ .Dt MANDOC 1 .Os .Sh NAME @@ -1357,6 +1357,10 @@ it is hard to predict which tab stop position the tab will advance to. Whitespace at the end of input lines is almost never semantically significant \(em but in the odd case where it might be, it is extremely confusing when reviewing and maintaining documents. +.It Sy "new sentence, new line" +.Pq mdoc +A new sentence starts in the middle of a text line. +Start it on a new input line to help formatters produce correct spacing. .It Sy "bad comment style" .Pq roff Comment lines start with a dot, a backslash, and a double-quote character. |