docs/115632: [geom][patch] Bad prototype in DECLARE_GEOM_CLASS(9) example

Romain Tartiere romain at blogreen.org
Sun Aug 19 21:50:02 UTC 2007


>Number:         115632
>Category:       docs
>Synopsis:       [geom][patch] Bad prototype in DECLARE_GEOM_CLASS(9) example
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Aug 19 21:50:01 GMT 2007
>Closed-Date:
>Last-Modified:
>Originator:     Romain Tartiere
>Release:        FreeBSD 6.2-STABLE i386
>Organization:
>Environment:
System: FreeBSD marvin.blogreen.org 6.2-STABLE FreeBSD 6.2-STABLE #5: Fri Aug 3 14:19:08 CEST 2007 root at marvin.blogreen.org:/usr/obj/usr/src/sys/MARVIN i386


	
>Description:
The documentation of DECLARE_GEOM_CLASS includes a short code snippet,
but the g_example_taste function return type is wrong:
 - "struct geom *" in the man page;
 - "struct g_geom *" in <geom/geom.h>.


>How-To-Repeat:
>Fix:


--- DECLARE_GEOM_CLASS.9.diff begins here ---
--- share/man/man9/DECLARE_GEOM_CLASS.9.orig	2007-08-19 23:20:54.000000000 +0200
+++ share/man/man9/DECLARE_GEOM_CLASS.9	2007-08-19 23:21:16.000000000 +0200
@@ -110,7 +110,7 @@
 .Sh EXAMPLES
 Example class declaration.
 .Bd -literal -offset indent
-static struct geom *
+static struct g_geom *
 g_example_taste(struct g_class *mp, struct g_provider *pp,
     int flags __unused)
 {
--- DECLARE_GEOM_CLASS.9.diff ends here ---


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



More information about the freebsd-doc mailing list