lib/42415: Synopsis of three proplib man pages is either missing functions or those functions are in wrong order

[silasdb%gmail.com@localhost]

>Number:         42415
>Category:       lib
>Synopsis:       Synopsis of three proplib man pages is either missing 
>functions or those functions are in wrong order
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    lib-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sat Dec 05 20:50:01 +0000 2009
>Originator:     Silas Silva
>Release:        -current
>Organization:
>Environment:
>Description:
Synopsis of prop_array(3), prop_data(3) and prop_string(3) is either missing 
functions or those functions are in wrong order.

In prop_array(3):

- The prop_array_equals is the last one in the SYNOPSIS section, while in 
DESCRIPTION, it is between prop_array_remove and prop_array_externalize.

In prop_data(3):

- In SYNOPSIS, prop_data_data and prop_data_size are inverted, compared to the 
DESCRIPTION section.

In prop_string(3):

- Where is prop_string_size and prop_string_mutable in SYNOPSIS?
>How-To-Repeat:
man prop_array prop_data prop_string
>Fix:
Apply the following patch on src/common/lib. It changes the SYNOPSIS of the 
quoted man pages.

(I didn't bump the date of them)


diff -ur libprop.orig/prop_array.3 libprop/prop_array.3
--- libprop.orig/prop_array.3   2009-12-05 17:56:02.000000000 -0200
+++ libprop/prop_array.3        2009-12-05 18:12:54.000000000 -0200
@@ -46,12 +46,12 @@
 .Nm prop_array_set ,
 .Nm prop_array_add ,
 .Nm prop_array_remove ,
+.Nm prop_array_equals
 .Nm prop_array_externalize ,
 .Nm prop_array_internalize ,
 .Nm prop_array_externalize_to_file ,
 .Nm prop_array_internalize_from_file ,
 .Nm prop_array_externalize_to_pref ,
-.Nm prop_array_equals
 .Nd array property collection object
 .Sh LIBRARY
 .Lb libprop
@@ -92,6 +92,9 @@
 .Ft void
 .Fn prop_array_remove "prop_array_t array" "unsigned int index"
 .\"
+.Ft bool
+.Fn prop_array_equals "prop_array_t array1" "prop_array_t array2"
+.\"
 .Ft char *
 .Fn prop_array_externalize "prop_array_t array"
 .Ft prop_array_t
@@ -105,8 +108,6 @@
 .Ft bool
 .Fn prop_array_externalize_to_pref "prop_array_t array" "struct plistref *pref"
 .\"
-.Ft bool
-.Fn prop_array_equals "prop_array_t array1" "prop_array_t array2"
 .Sh DESCRIPTION
 The
 .Nm prop_array
diff -ur libprop.orig/prop_data.3 libprop/prop_data.3
--- libprop.orig/prop_data.3    2009-12-05 17:56:02.000000000 -0200
+++ libprop/prop_data.3 2009-12-05 18:14:26.000000000 -0200
@@ -54,10 +54,10 @@
 .Ft prop_data_t
 .Fn prop_data_copy "prop_data_t data"
 .\"
-.Ft void *
-.Fn prop_data_data "prop_data_t data"
 .Ft size_t
 .Fn prop_data_size "prop_data_t data"
+.Ft void *
+.Fn prop_data_data "prop_data_t data"
 .Ft const void *
 .Fn prop_data_data_nocopy "prop_data_t data"
 .\"
diff -ur libprop.orig/prop_string.3 libprop/prop_string.3
--- libprop.orig/prop_string.3  2009-12-05 17:56:02.000000000 -0200
+++ libprop/prop_string.3       2009-12-05 18:07:19.000000000 -0200
@@ -63,6 +63,12 @@
 .Ft prop_string_t
 .Fn prop_string_copy_mutable "prop_string_t string"
 .\"
+.Ft size_t
+.Fn prop_string_size "prop_string_t string"
+.\"
+.Ft bool
+.Fn prop_string_mutable "prop_string_t string"
+.\"
 .Ft char *
 .Fn prop_string_cstring "prop_string_t string"
 .Ft const char *