]> git.cameronkatri.com Git - mandoc.git/commitdiff
1) Remove documentation of the groff-1.15 compatibility quirk
authorIngo Schwarze <schwarze@openbsd.org>
Wed, 29 Aug 2012 23:38:50 +0000 (23:38 +0000)
committerIngo Schwarze <schwarze@openbsd.org>
Wed, 29 Aug 2012 23:38:50 +0000 (23:38 +0000)
of suppressing spacing before a third .Xr argument
because that quirk was removed in mdoc_macro.c rev. 1.113.

2) Mark the "section" argument to .Xr as (syntactically) optional,
but still do not encourage omitting it.
The missing .Op was reported by espie@.

Wording tweaked by and ok jmc@, ok millert@.

mdoc.7

diff --git a/mdoc.7 b/mdoc.7
index 4c1f92227d40f6c22032068872cb080aa2c74528..5b0ce6e9bc361681612fb2b0ac1df1a44f1bdd2f 100644 (file)
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\"    $Id: mdoc.7,v 1.215 2012/06/20 22:06:30 schwarze Exp $
+.\"    $Id: mdoc.7,v 1.216 2012/08/29 23:38:50 schwarze Exp $
 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010, 2011 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: June 20 2012 $
+.Dd $Mdocdate: August 29 2012 $
 .Dt MDOC 7
 .Os
 .Sh NAME
@@ -2532,20 +2532,14 @@ Link to another manual
 .Pq Qq cross-reference .
 Its syntax is as follows:
 .Pp
-.D1 Pf \. Sx \&Xr Ar name section
+.D1 Pf \. Sx \&Xr Ar name Op section
 .Pp
-The
+Cross reference the
 .Ar name
 and
 .Ar section
-are the name and section of the linked manual.
-If
-.Ar section
-is followed by non-punctuation, an
-.Sx \&Ns
-is inserted into the token stream.
-This behaviour is for compatibility with
-GNU troff.
+number of another man page;
+omitting the section number is rarely useful.
 .Pp
 Examples:
 .Dl \&.Xr mandoc 1