[patch] documentation fix: mbuf(9) and <sys/mbuf.h>

View: New views
2 Messages — Rating Filter:   Alert me  

[patch] documentation fix: mbuf(9) and <sys/mbuf.h>

by Jordan Gordeev :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

The commit by thib@ from 2007-05-28 15:02:49 moves the definitions of
the MSIZE and MCLBYTES macros from <machine/param.h> to <sys/param.h>,
without updating the mbuf man page or the comments in <sys/mbuf.h>.
Jonathan Thornburg reported (in PR documentation/5792) one place where
the documentation was not updated.
The included patch fixes three other such places.

Index: sys/sys/mbuf.h
===================================================================
RCS file: /u1/obsd/src/sys/sys/mbuf.h,v
retrieving revision 1.102
diff -u -r1.102 mbuf.h
--- sys/sys/mbuf.h    14 Aug 2008 19:39:40 -0000    1.102
+++ sys/sys/mbuf.h    28 Aug 2008 11:11:36 -0000
@@ -37,9 +37,9 @@
 #include <sys/queue.h>
 
 /*
- * Mbufs are of a single size, MSIZE (machine/param.h), which
+ * Mbufs are of a single size, MSIZE (sys/param.h), which
  * includes overhead.  An mbuf may add a single "mbuf cluster" of size
- * MCLBYTES (also in machine/param.h), which has no additional overhead
+ * MCLBYTES (also in sys/param.h), which has no additional overhead
  * and is used instead of the internal data area; this is done when
  * at least MINCLSIZE of data must be stored.
  */
Index: share/man/man9/mbuf.9
===================================================================
RCS file: /u1/obsd/src/share/man/man9/mbuf.9,v
retrieving revision 1.32
diff -u -r1.32 mbuf.9
--- share/man/man9/mbuf.9    13 Apr 2008 14:13:14 -0000    1.32
+++ share/man/man9/mbuf.9    28 Aug 2008 11:12:48 -0000
@@ -259,7 +259,7 @@
 An external cluster is used when the data to hold in the mbuf is
 large.
 The size of an external cluster is MCLBYTES
-.Pq also defined in Aq Pa machine/param.h .
+.Pq also defined in Aq Pa sys/param.h .
 A cluster should be used when the size of the data reach MINCLSIZE
 (the minimum size to be held by an external cluster).
 .Pp


Re: [patch] documentation fix: mbuf(9) and <sys/mbuf.h>

by Jason McIntyre-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

On Thu, Aug 28, 2008 at 02:32:13PM +0300, Jordan Gordeev wrote:
> The commit by thib@ from 2007-05-28 15:02:49 moves the definitions of
> the MSIZE and MCLBYTES macros from <machine/param.h> to <sys/param.h>,
> without updating the mbuf man page or the comments in <sys/mbuf.h>.
> Jonathan Thornburg reported (in PR documentation/5792) one place where
> the documentation was not updated.
> The included patch fixes three other such places.
>

fixed, thanks.
jmc

> Index: sys/sys/mbuf.h
> ===================================================================
> RCS file: /u1/obsd/src/sys/sys/mbuf.h,v
> retrieving revision 1.102
> diff -u -r1.102 mbuf.h
> --- sys/sys/mbuf.h    14 Aug 2008 19:39:40 -0000    1.102
> +++ sys/sys/mbuf.h    28 Aug 2008 11:11:36 -0000
> @@ -37,9 +37,9 @@
> #include <sys/queue.h>
>
> /*
> - * Mbufs are of a single size, MSIZE (machine/param.h), which
> + * Mbufs are of a single size, MSIZE (sys/param.h), which
>  * includes overhead.  An mbuf may add a single "mbuf cluster" of size
> - * MCLBYTES (also in machine/param.h), which has no additional overhead
> + * MCLBYTES (also in sys/param.h), which has no additional overhead
>  * and is used instead of the internal data area; this is done when
>  * at least MINCLSIZE of data must be stored.
>  */
> Index: share/man/man9/mbuf.9
> ===================================================================
> RCS file: /u1/obsd/src/share/man/man9/mbuf.9,v
> retrieving revision 1.32
> diff -u -r1.32 mbuf.9
> --- share/man/man9/mbuf.9    13 Apr 2008 14:13:14 -0000    1.32
> +++ share/man/man9/mbuf.9    28 Aug 2008 11:12:48 -0000
> @@ -259,7 +259,7 @@
> An external cluster is used when the data to hold in the mbuf is
> large.
> The size of an external cluster is MCLBYTES
> -.Pq also defined in Aq Pa machine/param.h .
> +.Pq also defined in Aq Pa sys/param.h .
> A cluster should be used when the size of the data reach MINCLSIZE
> (the minimum size to be held by an external cluster).
> .Pp

LightInTheBox - Buy quality products at wholesale price!