diff options
| author |   Ingo Schwarze <schwarze@openbsd.org> | 2017-07-02 15:31:59 +0000 |
|---|---|---|
| committer | Ingo Schwarze <schwarze@openbsd.org> | 2017-07-02 15:31:59 +0000 |
| commit | e5501471e172d4f6de0c3e4afca1fffb5cc93ea7 (patch) | |
| tree | 050e48715fe221def4dff8fb7079f2a07fa7e9fd /mandoc.1 | |
| parent | 2a02f7a0af4b53898861601ef0745e74f3966315 (diff) | |
| download | mandoc-e5501471e172d4f6de0c3e4afca1fffb5cc93ea7.tar.gz mandoc-e5501471e172d4f6de0c3e4afca1fffb5cc93ea7.tar.zst mandoc-e5501471e172d4f6de0c3e4afca1fffb5cc93ea7.zip | |
add warning "cross reference to self"; inspired by mdoclint
Diffstat (limited to 'mandoc.1')
| -rw-r--r-- | mandoc.1 | 22 |
1 files changed, 20 insertions, 2 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.210 2017/07/01 09:47:30 schwarze Exp $ +.\" $Id: mandoc.1,v 1.211 2017/07/02 15:31:59 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: July 1 2017 $ +.Dd $Mdocdate: July 2 2017 $ .Dt MANDOC 1 .Os .Sh NAME @@ -1097,6 +1097,24 @@ The same standard section title occurs more than once. .Pq mdoc A standard section header occurs in a section of the manual where it normally isn't useful. +.It Sy "cross reference to self" +.Pq mdoc +An +.Ic \&Xr +macro refers to a name and section matching the section of the present +manual page and a name mentioned in an +.Ic \&Nm +macro in the NAME or SYNOPSIS section, or in an +.Ic \&Fn +or +.Ic \&Fo +macro in the SYNOPSIS. +Consider using +.Ic \&Nm +or +.Ic \&Fn +instead of +.Ic \&Xr . .It Sy "unusual Xr order" .Pq mdoc In the SEE ALSO section, an |