Re: yacc(1) mandoc nits

2013-08-12 Thread Jason McIntyre
On Sun, Aug 11, 2013 at 10:49:27PM +0200, Jan Stary wrote:
 Tha yacc(1) manpage uses
 
   .Tn LALR(1)
   .Tn LR(1)
 
 I don't think LALR or LR is a tradename.
 This seems to be what mdoc(7) describes as:
 
 Since this macro is often implemented to use a small caps
 font, it has historically been used for acronyms (like
 ASCII) as well.  Such usage is not recommended because it
 would use the same macro sometimes for semantical annotation,
 sometimes for physical formatting.
 
 So would it be better to just say LALR(1) without
 any markup, just as we say e.g. BNF?
 
   Jan
 

yes, Tn gets abused horribly. however it's everwhere, so i wouldn;t want
to tackle it in a single page. we would have to decide where exactly it
makes sense (never, as far as i'm concerned), then do it everywhere
consistently.

jmc

 
 Index: yacc.1
 ===
 RCS file: /cvs/src/usr.bin/yacc/yacc.1,v
 retrieving revision 1.26
 diff -u -p -r1.26 yacc.1
 --- yacc.118 Oct 2010 14:42:16 -  1.26
 +++ yacc.111 Aug 2013 20:48:37 -
 @@ -37,9 +37,7 @@
  .Os
  .Sh NAME
  .Nm yacc
 -.Nd an
 -.Tn LALR(1)
 -parser generator
 +.Nd an LALR(1) parser generator
  .Sh SYNOPSIS
  .Nm yacc
  .Op Fl dlrtv
 @@ -51,11 +49,8 @@ parser generator
  .Nm
  reads the grammar specification in
  .Ar file
 -and generates an
 -.Tn LR(1)
 -parser for it.
 -The parsers consist of a set of
 -.Tn LALR(1)
 +and generates an LR(1) parser for it.
 +The parsers consist of a set of LALR(1)
  parsing tables and a driver routine
  written in the C programming language.
  .Nm
 @@ -176,8 +171,7 @@ is defined and non-zero.
  .Sh DIAGNOSTICS
  If there are rules that are never reduced, the number of such rules is
  written to the standard error.
 -If there are any
 -.Tn LALR(1)
 +If there are any LALR(1)
  conflicts, the number of conflicts is also written
  to the standard error.
  .Sh SEE ALSO



remove .Tn abuse [was: yacc(1) mandoc nits]

2013-08-12 Thread Jan Stary
On Aug 12 07:11:16, j...@kerhand.co.uk wrote:
 On Sun, Aug 11, 2013 at 10:49:27PM +0200, Jan Stary wrote:
  Tha yacc(1) manpage uses
  
  .Tn LALR(1)
  .Tn LR(1)
  
  I don't think LALR or LR is a tradename.
  This seems to be what mdoc(7) describes as:
  
  Since this macro is often implemented to use a small caps
  font, it has historically been used for acronyms (like
  ASCII) as well.  Such usage is not recommended because it
  would use the same macro sometimes for semantical annotation,
  sometimes for physical formatting.
  
  So would it be better to just say LALR(1) without
  any markup, just as we say e.g. BNF?
  
  Jan
  
 
 yes, Tn gets abused horribly. however it's everwhere, so i wouldn;t want
 to tackle it in a single page. we would have to decide where exactly it
 makes sense (never, as far as i'm concerned), then do it everywhere
 consistently.

The diff below removes them from bin/ games/ and sys/ (more to come)
leaving only those that are actualy tradenames, as in .Tn ATT

Jan


Index: bin/cat/cat.1
===
RCS file: /cvs/src/bin/cat/cat.1,v
retrieving revision 1.33
diff -u -p -u -p -r1.33 cat.1
--- bin/cat/cat.1   16 Jul 2013 06:52:05 -  1.33
+++ bin/cat/cat.1   12 Aug 2013 19:24:20 -
@@ -92,12 +92,9 @@ which are displayed normally.
 The tab character, control-I, can be made visible via the
 .Fl t
 option.
-The
-.Tn DEL
-character (octal 0177) prints as
+The DEL character (octal 0177) prints as
 .Ql ^? .
-.Pf Non- Ns Tn ASCII
-characters (with the high bit set) are printed as
+Non-ASCII characters (with the high bit set) are printed as
 .Ql M-
 (for meta) followed by the character for the low 7 bits.
 .El
Index: bin/chio/chio.1
===
RCS file: /cvs/src/bin/chio/chio.1,v
retrieving revision 1.32
diff -u -p -u -p -r1.32 chio.1
--- bin/chio/chio.1 15 Jul 2013 23:43:58 -  1.32
+++ bin/chio/chio.1 12 Aug 2013 19:24:20 -
@@ -243,8 +243,7 @@ Configure the changer to use picker 2 (t
 .Sh AUTHORS
 The
 .Nm
-program and
-.Tn SCSI
+program and SCSI
 changer driver were written by
 .An Jason R. Thorpe Aq Mt thor...@and.com
 for And Communications
Index: bin/csh/csh.1
===
RCS file: /cvs/src/bin/csh/csh.1,v
retrieving revision 1.67
diff -u -p -u -p -r1.67 csh.1
--- bin/csh/csh.1   15 Jan 2012 20:06:40 -  1.67
+++ bin/csh/csh.1   12 Aug 2013 19:24:20 -
@@ -179,8 +179,7 @@ in the home directory of the invoker,
 and, if this is a login shell, the file
 .Pa \.login
 in the same location.
-It is typical for users on
-.Tn CRT Ns s
+It is typical for users on CRTs
 to put the command
 .Ic stty crt
 in their
@@ -1686,9 +1685,7 @@ Like
 but no
 .Ql \e
 escapes are recognized and words are delimited
-by
-.Tn NUL
-characters in the output.
+by NUL characters in the output.
 Useful for programs that wish to use the shell to filename expand a list
 of words.
 .Pp
@@ -1945,9 +1942,7 @@ to the given
 The final two forms run command at priority 4 and
 .Ar number
 respectively.
-The greater the number, the less
-.Tn CPU
-the process will get.
+The greater the number, the less CPU the process will get.
 The superuser may specify negative priority by using
 .Dq nice \-number ... .
 .Ar command
@@ -2579,9 +2574,7 @@ Built-in commands that fail return exit 
 all other built-in commands set status to 0.
 .It Ic time
 Controls automatic timing of commands.
-If set, then any command that takes more than this many
-.Tn CPU
-seconds
+If set, then any command that takes more than this many CPU seconds
 will cause a line giving user, system, and real times, and a utilization
 percentage which is the ratio of user plus system times to real time
 to be printed when it terminates.
Index: bin/date/date.1
===
RCS file: /cvs/src/bin/date/date.1,v
retrieving revision 1.59
diff -u -p -u -p -r1.59 date.1
--- bin/date/date.1 31 Aug 2011 08:48:40 -  1.59
+++ bin/date/date.1 12 Aug 2013 19:24:20 -
@@ -93,8 +93,7 @@ Print out (in specified format) the date
 .Ar seconds
 from the Epoch.
 .It Fl t Ar minutes_west
-Set the system's value for minutes west of
-.Tn GMT .
+Set the system's value for minutes west of GMT.
 .Ar minutes_west
 specifies the number of minutes returned in
 .Fa tz_minuteswest
Index: bin/dd/dd.1
===
RCS file: /cvs/src/bin/dd/dd.1,v
retrieving revision 1.25
diff -u -p -u -p -r1.25 dd.1
--- bin/dd/dd.1 18 Oct 2011 09:37:35 -  1.25
+++ bin/dd/dd.1 12 Aug 2013 19:24:20 -
@@ -123,9 +123,7 @@ using the tape
 .Xr ioctl 2
 function calls.
 If the seek operation is past the end of file, space from the current
-end of file to the specified offset is filled with blocks of

yacc(1) mandoc nits

2013-08-11 Thread Jan Stary
Tha yacc(1) manpage uses

.Tn LALR(1)
.Tn LR(1)

I don't think LALR or LR is a tradename.
This seems to be what mdoc(7) describes as:

Since this macro is often implemented to use a small caps
font, it has historically been used for acronyms (like
ASCII) as well.  Such usage is not recommended because it
would use the same macro sometimes for semantical annotation,
sometimes for physical formatting.

So would it be better to just say LALR(1) without
any markup, just as we say e.g. BNF?

Jan


Index: yacc.1
===
RCS file: /cvs/src/usr.bin/yacc/yacc.1,v
retrieving revision 1.26
diff -u -p -r1.26 yacc.1
--- yacc.1  18 Oct 2010 14:42:16 -  1.26
+++ yacc.1  11 Aug 2013 20:48:37 -
@@ -37,9 +37,7 @@
 .Os
 .Sh NAME
 .Nm yacc
-.Nd an
-.Tn LALR(1)
-parser generator
+.Nd an LALR(1) parser generator
 .Sh SYNOPSIS
 .Nm yacc
 .Op Fl dlrtv
@@ -51,11 +49,8 @@ parser generator
 .Nm
 reads the grammar specification in
 .Ar file
-and generates an
-.Tn LR(1)
-parser for it.
-The parsers consist of a set of
-.Tn LALR(1)
+and generates an LR(1) parser for it.
+The parsers consist of a set of LALR(1)
 parsing tables and a driver routine
 written in the C programming language.
 .Nm
@@ -176,8 +171,7 @@ is defined and non-zero.
 .Sh DIAGNOSTICS
 If there are rules that are never reduced, the number of such rules is
 written to the standard error.
-If there are any
-.Tn LALR(1)
+If there are any LALR(1)
 conflicts, the number of conflicts is also written
 to the standard error.
 .Sh SEE ALSO