documentation/5134: diff to route.8 to improve clarity of modifier syntax

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

documentation/5134: diff to route.8 to improve clarity of modifier syntax

Josh Grosse
>Number:         5134
>Category:       documentation
>Synopsis:       It is easy to misunderstand route command syntax
>Confidential:   yes
>Severity:       non-critical
>Priority:       low
>Responsible:    bugs
>State:          open
>Quarter:        
>Keywords:      
>Date-Required:
>Class:          change-request
>Submitter-Id:   net
>Arrival-Date:   Wed May 24 19:20:01 GMT 2006
>Closed-Date:
>Last-Modified:
>Originator:     Josh Grosse
>Release:        diff to route.8 1.44 included
>Organization:
net
>Environment:
        System      : OpenBSD 3.9
        Architecture: OpenBSD.i386
        Machine     : i386
>Description:
        Based on an IRC conversation that took place on #OpenBSD today, it
        is possible to mis-read route command syntax, type in the
        wrong command, and misunderstand the resulting error message.
>How-To-Repeat:
        Read quickly, glance at the man page rather than fully ingesting it.
>Fix:
        Here's a diff that tries to improve the already excellent document:

--- route.8.rev.1.44 Wed May 24 14:01:49 2006
+++ route.8.proposed.1.45 Wed May 24 15:08:07 2006
@@ -171,6 +171,12 @@
 .Ar destination gateway Op Ar netmask
 .Ed
 .Pp
+.Op Ar modifiers
+are one or more optional keywords that must be used before
+.Ar destination
+which may set or clear flags, specify interfaces or interface families,
+specify addresses, attach labels, or make other myriad modifications
+to a route entry.
 .Ar destination
 is the destination host or network,
 .Ar gateway


>Release-Note:
>Audit-Trail:
>Unformatted:

Reply | Threaded
Open this post in threaded view
|

Re: documentation/5134: diff to route.8 to improve clarity of modifier syntax

Jason McIntyre-2
The following reply was made to PR documentation/5134; it has been noted by GNATS.

From: Jason McIntyre <[hidden email]>
To: [hidden email]
Cc: [hidden email]
Subject: Re: documentation/5134: diff to route.8 to improve clarity of modifier syntax
Date: Thu, 25 May 2006 09:31:49 +0059

 On Wed, May 24, 2006 at 03:20:12PM -0400, [hidden email] wrote:
 > >Number:         5134
 > >Category:       documentation
 > >Synopsis:       It is easy to misunderstand route command syntax
 
 > >Description:
 > Based on an IRC conversation that took place on #OpenBSD today, it
 > is possible to mis-read route command syntax, type in the
 > wrong command, and misunderstand the resulting error message.
 > >How-To-Repeat:
 > Read quickly, glance at the man page rather than fully ingesting it.
 > >Fix:
 > Here's a diff that tries to improve the already excellent document:
 >
 
    Fix:
  Do not read quickly. Fully digest the man page, rather than glancing
  at it.
 
 jmc