Subject: misc/15526: request to change ALTQ to .Nm in altq.9 manpage
To: None <gnats-bugs@gnats.netbsd.org>
From: None <keramida@FreeBSD.org>
List: netbsd-bugs
Date: 02/07/2002 06:35:51
>Number:         15526
>Category:       misc
>Synopsis:       request to change ALTQ to .Nm in altq.9 manpage
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Thu Feb 07 06:36:00 PST 2002
>Closed-Date:
>Last-Modified:
>Originator:     Giorgos Keramidas
>Release:        
>Organization:
>Environment:
>Description:
The manpage of altq.9 uses "ALTQ" inline in the text.
The diff attached changes all instances of ALTQ to .Nm
Sorry for creating a -c diff, but Solaris' version of diff
that I have right now, doesn't have GNU's -u option :-(

The attached diff (in case gnats messes with the wrapping,
whitespaces, etc. and makes the diff hard to apply) can also
be found at:
http://students.ceid.upatras.gr/~keramida/netbsd/altq.9.diff


>How-To-Repeat:

>Fix:
*** altq.9.orig	Thu Feb  7 16:25:40 2002
--- altq.9	Thu Feb  7 16:26:47 2002
***************
*** 59,70 ****
  .Ft void \"macro
  .Fn IFQ_SET_READY "struct ifaltq *ifq"
  .Sh DESCRIPTION
! The ALTQ system is a framework to manage queueing disciplines on network
! interfaces.  ALTQ introduces new macros to manipulate output queues.
  The output queue macros are used to abstract queue operations and not to
  touch the internal fields of the output queue structure.
! The macros are independent from the ALTQ implementation, and compatible with the
! traditional
  .Dv ifqueue
  macros for ease of transition.
  .Pp
--- 59,75 ----
  .Ft void \"macro
  .Fn IFQ_SET_READY "struct ifaltq *ifq"
  .Sh DESCRIPTION
! The
! .Nm 
! system is a framework to manage queueing disciplines on network
! interfaces.
! .Nm
! introduces new macros to manipulate output queues.
  The output queue macros are used to abstract queue operations and not to
  touch the internal fields of the output queue structure.
! The macros are independent from the
! .Nm
! implementation, and compatible with the traditional
  .Dv ifqueue
  macros for ease of transition.
  .Pp
***************
*** 139,145 ****
  .Pp
  .Fn IFQ_SET_READY
  sets a flag to indicate this driver is converted to use the new macros.
! ALTQ can be enabled only on interfaces with this flag.
  .Sh COMPATIBILITY
  .Ss ifaltq structure
  In order to keep compatibility with the existing code, the new
--- 144,151 ----
  .Pp
  .Fn IFQ_SET_READY
  sets a flag to indicate this driver is converted to use the new macros.
! .Nm
! can be enabled only on interfaces with this flag.
  .Sh COMPATIBILITY
  .Ss ifaltq structure
  In order to keep compatibility with the existing code, the new
***************
*** 484,490 ****
  Some (pseudo) devices (such as slip) have another
  .Dv ifqueue
  to prioritize packets.  It is possible to eliminate the second queue
! since ALTQ provides more flexible mechanisms but the following shows
  how to keep the original behavior.
  .Bd -literal
  struct sl_softc {
--- 490,498 ----
  Some (pseudo) devices (such as slip) have another
  .Dv ifqueue
  to prioritize packets.  It is possible to eliminate the second queue
! since
! .Nm
! provides more flexible mechanisms but the following shows
  how to keep the original behavior.
  .Bd -literal
  struct sl_softc {


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