aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mdoc.7
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2016-12-28 17:34:18 +0000
committerIngo Schwarze <schwarze@openbsd.org>2016-12-28 17:34:18 +0000
commit680c932a062c93aa4d054794539b762b8c62b781 (patch)
treeee7554c1bc5f564cf720259e483a9c5913b549f2 /mdoc.7
parent296ca97e61f5c92e7b681de5cfbefd00df41afe0 (diff)
downloadmandoc-680c932a062c93aa4d054794539b762b8c62b781.tar.gz
mandoc-680c932a062c93aa4d054794539b762b8c62b781.tar.zst
mandoc-680c932a062c93aa4d054794539b762b8c62b781.zip
Make the second, section number argument of .Xr mandatory.
In fact, we have been requiring it for many years. The only reason to not warn when it was missing was excessive traditionalism - it was optional in 4.4BSD.
Diffstat (limited to 'mdoc.7')
-rw-r--r--mdoc.711
1 files changed, 5 insertions, 6 deletions
diff --git a/mdoc.7 b/mdoc.7
index d8bfecc4..38e87b60 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.7,v 1.258 2016/10/11 17:30:33 schwarze Exp $
+.\" $Id: mdoc.7,v 1.259 2016/12/28 17:34:18 schwarze Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2010, 2011, 2013 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: October 11 2016 $
+.Dd $Mdocdate: December 28 2016 $
.Dt MDOC 7
.Os
.Sh NAME
@@ -2714,14 +2714,13 @@ Link to another manual
.Pq Qq cross-reference .
Its syntax is as follows:
.Pp
-.D1 Pf \. Sx \&Xr Ar name Op section
+.D1 Pf \. Sx \&Xr Ar name section
.Pp
Cross reference the
.Ar name
and
.Ar section
-number of another man page;
-omitting the section number is rarely useful.
+number of another man page.
.Pp
Examples:
.Dl \&.Xr mandoc 1
@@ -3033,7 +3032,7 @@ then the macro accepts an arbitrary number of arguments.
.It Sx \&Ux Ta Yes Ta Yes Ta n
.It Sx \&Va Ta Yes Ta Yes Ta n
.It Sx \&Vt Ta Yes Ta Yes Ta >0
-.It Sx \&Xr Ta Yes Ta Yes Ta >0
+.It Sx \&Xr Ta Yes Ta Yes Ta 2
.It Sx \&br Ta \&No Ta \&No Ta 0
.It Sx \&sp Ta \&No Ta \&No Ta 1
.El