[src/trunk]: src/share/man/man9 Grammar, whitespace and typo fixes.

[wiz <wiz%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/46856e58438d
branches:  trunk
changeset: 512640:46856e58438d
user:      wiz <wiz%NetBSD.org@localhost>
date:      Thu Jul 12 15:03:08 2001 +0000

description:
Grammar, whitespace and typo fixes.

diffstat:

 share/man/man9/altq.9 |  53 ++++++++++++++++++++++++++------------------------
 1 files changed, 28 insertions(+), 25 deletions(-)

diffs (158 lines):

diff -r 37a44fb3787a -r 46856e58438d share/man/man9/altq.9
--- a/share/man/man9/altq.9     Thu Jul 12 12:43:21 2001 +0000
+++ b/share/man/man9/altq.9     Thu Jul 12 15:03:08 2001 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: altq.9,v 1.2 2001/07/12 12:43:21 itojun Exp $
+.\"    $NetBSD: altq.9,v 1.3 2001/07/12 15:03:08 wiz Exp $
 .\"    $OpenBSD: altq.9,v 1.4 2001/07/12 12:41:42 itojun Exp $
 .\"
 .\" Copyright (C) 2001
@@ -70,15 +70,14 @@
 .Pp
 .Fn IFQ_ENQUEUE
 enqueues a packet
-.Fa m ,
-to the queue 
+.Fa m
+to the queue
 .Fa ifq .
 The underlying queueing discipline may discard the packet.
-0 is set to
 .Fa error
-on success and 
+is set to 0 on success, or
 .Dv ENOBUFS
-is set if the packet is discarded.
+if the packet is discarded.
 .Fa m
 will be freed by the device driver on success or by the queueing discipline on
 failure so that the caller should not touch
@@ -87,11 +86,13 @@
 .Fn IFQ_ENQUEUE .
 .Pp
 .Fn IFQ_DEQUEUE
-dequeues a packet from the queue.  The dequeued packet is set to
+dequeues a packet from the queue.  The dequeued packet is returned in
 .Fa m ,
 or
+.Fa m
+is set to
 .Dv NULL
-is set if no packet is dequeued.
+if no packet is dequeued.
 The caller must always check
 .Fa m
 since a non-empty queue could return
@@ -112,7 +113,7 @@
 emptied by a dequeue loop.
 .Pp
 .Fn IFQ_CLASSIFY
-classifies a packet to a scheduling class, and set the result to
+classifies a packet to a scheduling class, and returns the result in
 .Fa pktattr .
 .Pp
 .Fn IFQ_IS_EMPTY
@@ -146,7 +147,7 @@
 .Dv ifaltq
 has the same fields.  The traditional
 .Fn IF_XXX
-macros and the code directly referencing to the fields within
+macros and the code directly referencing the fields within
 .Dv if_snd
 still work with
 .Dv ifaltq .
@@ -197,8 +198,8 @@
        #endif
 .Ed
 .Ss Enqueue operation
-The semantics of the enqueue operation is changed.  In the new style,
-the enqueue and packet drop are combined since they cannot be easily
+The semantics of the enqueue operation are changed.  In the new style,
+enqueue and packet drop are combined since they cannot be easily
 separated in many queueing disciplines.
 The new enqueue operation corresponds to the following macro that is
 written with the old macros.
@@ -224,11 +225,11 @@
 .It
 drop (and free) a packet if the enqueue operation fails
 .El
-If the enqueue operation fails, an error
-.Dv ENOBUFS
+If the enqueue operation fails,
+.Fa error 
 is set to
-.Dv error .
-.Dv mbuf
+.Dv ENOBUFS .
+.Fa mbuf
 is freed by the queueing discipline.
 The caller should not touch mbuf after calling
 .Fn IFQ_ENQUEUE
@@ -247,7 +248,7 @@
 .Bd -literal
             ##old-style##                           ##new-style##
                                        |
- int                                   | int 
+ int                                   | int
  ether_output(ifp, m0, dst, rt0)       | ether_output(ifp, m0, dst, rt0)
  {                                     | {
      ......                            |     ......
@@ -345,7 +346,7 @@
 could still return
 .Dv NULL
 if the queue is under rate-limiting.
-.Ss Dequeue operaion
+.Ss Dequeue operation
 Replace
 .Fn IF_DEQUEUE
 by
@@ -449,12 +450,14 @@
 .Ss Attach routine
 Use
 .Fn IFQ_SET_MAXLEN
-to set a value to
-.Fa ifq_maxlen .
+to set
+.Fa ifq_maxlen
+to
+.Fa len .
 Add
 .Fn IFQ_SET_READY
 to show this driver is converted to the new style.
-(this is used to distinguish new-style drivers.)
+(This is used to distinguish new-style drivers.)
 .Bd -literal
             ##old-style##                           ##new-style##
                                        |
@@ -472,11 +475,11 @@
                                        |
  ifp->if_snd.ifq_len++;                | IFQ_INC_LEN(&ifp->if_snd);
                                        |
- ifp->if_snd.ifq_len--;                | IFQ_INC_LEN(&ifp->if_snd);
+ ifp->if_snd.ifq_len--;                | IFQ_DEC_LEN(&ifp->if_snd);
                                        |
 .Ed
 Some drivers instruct the hardware to invoke transmission complete
-interruts only when it thinks necessary.  Rate-limiting breaks its assumption.
+interrupts only when it thinks necessary.  Rate-limiting breaks its assumption.
 .Ss How to convert drivers using multiple ifqueues
 Some (pseudo) devices (such as slip) have another
 .Dv ifqueue
@@ -527,7 +530,7 @@
  }                                     |         error = 0;
  IF_ENQUEUE(ifq, m);                   |     }
                                        | } else
-                                       |     IFQ_ENQUEUE(&sc->sc_if.if_snd, 
+                                       |     IFQ_ENQUEUE(&sc->sc_if.if_snd,
                                        |                 m, error);
                                        |
                                        | if (error) {
@@ -554,7 +557,7 @@
 .Ed
 .Sh QUEUEING DISCIPLINES
 Queueing disciplines need to maintain
-.Fa ifq_len .
+.Fa ifq_len
 .Po
 used by
 .Fn IFQ_IS_EMPTY