Update and clean up uuid man pages, including renaming libuuid.3 to

uuid.3

Eliminate empty lines at end of uuid.h

diff --git a/debian/uuid-dev.files b/debian/uuid-dev.files
index 4a8dcb7b85630c942d2179965443e0ba3a781cce..3e2953820e3f5cae73f2367e2621030238bed98f 100644 (file)
--- a/debian/uuid-dev.files
+++ b/debian/uuid-dev.files
@@ -1,5 +1,4 @@
 usr/lib/libuuid.so
 usr/lib/libuuid.a
 usr/include/uuid/*
-usr/share/man/man3/libuuid*
-usr/share/man/man3/uuid_*
+usr/share/man/man3/uuid*

diff --git a/e2fsprogs.spec.in b/e2fsprogs.spec.in
index b0fd0e2d321a3ed83e0fdbf82ad017f72864dd25..23fa559e82d9cc4acda88ed8ee8dd08e774fafbb 100644 (file)
--- a/e2fsprogs.spec.in
+++ b/e2fsprogs.spec.in
@@ -167,7 +167,7 @@ exit 0
 %{_mandir}/man1/mk_cmds.1*
 %{_mandir}/man3/com_err.3*
 %{_mandir}/man3/libblkid.3*
-%{_mandir}/man3/libuuid.3*
+%{_mandir}/man3/uuid.3*
 %{_mandir}/man3/uuid_clear.3*
 %{_mandir}/man3/uuid_compare.3*
 %{_mandir}/man3/uuid_copy.3*

diff --git a/lib/uuid/ChangeLog b/lib/uuid/ChangeLog
index ba1e63c8dd046a9395fe1d851e89e63acb1c2e4d..2706bdc44214da3c2a982a0bc89ef9b4f4738b17 100644 (file)
--- a/lib/uuid/ChangeLog
+++ b/lib/uuid/ChangeLog
@@ -1,5 +1,7 @@
 2004-05-04  Theodore Ts'o  <tytso@mit.edu>
 
+       * Update and clean up uuid man pages
+
        * gen_uuid.c (uuid_generate_time): Mask off the timestamp to avoid
                a Y8.8888K problem.
 

diff --git a/lib/uuid/Makefile.in b/lib/uuid/Makefile.in
index 3c68eb23ac1453edd5216d39c951379d7afa18d1..18b38669a0ca9ba68c15756db985ee41dd13c7df 100644 (file)
--- a/lib/uuid/Makefile.in
+++ b/lib/uuid/Makefile.in
@@ -12,7 +12,7 @@ INSTALL = @INSTALL@
 
 all:: 
 
-SMANPAGES=     libuuid.3 uuid_clear.3 uuid_compare.3 uuid_copy.3 \
+SMANPAGES=     uuid.3 uuid_clear.3 uuid_compare.3 uuid_copy.3 \
                uuid_generate.3 uuid_is_null.3 uuid_parse.3 \
                uuid_time.3 uuid_unparse.3
 
@@ -93,8 +93,8 @@ uuid_time: $(srcdir)/uuid_time.c $(DEPLIBUUID)
        $(CC) $(ALL_CFLAGS) -DDEBUG -o uuid_time $(srcdir)/uuid_time.c \
                $(LIBUUID)
 
-libuuid.3: $(DEP_SUBSTITUTE) $(srcdir)/libuuid.3.in
-       $(SUBSTITUTE_UPTIME) $(srcdir)/libuuid.3.in libuuid.3
+uuid.3: $(DEP_SUBSTITUTE) $(srcdir)/uuid.3.in
+       $(SUBSTITUTE_UPTIME) $(srcdir)/uuid.3.in uuid.3
 
 uuid_clear.3: $(DEP_SUBSTITUTE) $(srcdir)/uuid_clear.3.in
        $(SUBSTITUTE_UPTIME) $(srcdir)/uuid_clear.3.in uuid_clear.3

diff --git a/lib/uuid/libuuid.3.in b/lib/uuid/uuid.3.in
similarity index 81%
rename from lib/uuid/libuuid.3.in
rename to lib/uuid/uuid.3.in
index 1611bd6b8a0c1b21d3d71196783c590d841fa8b0..18760fe3c13f229308c4bfb142fbf53cbf0bb7d7 100644 (file)
--- a/lib/uuid/libuuid.3.in
+++ b/lib/uuid/uuid.3.in
@@ -29,21 +29,14 @@
 .\" %End-Header%
 .\" 
 .\" Created  Wed Mar 10 17:42:12 1999, Andreas Dilger
-.TH LIBUUID 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
+.TH UUID 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
 .SH NAME
-libuuid \- DCE compatible Universally Unique Identifier library
+uuid \- DCE compatible Universally Unique Identifier library
 .SH SYNOPSIS
 .B #include <uuid/uuid.h>
-.sp
-.B cc
-.I file.c
-.B \-luuid
 .SH DESCRIPTION
-The
-.B libuuid
-library is used to generate unique identifiers for objects that may be
-accessible beyond the local system.  The Linux implementation was created
-to uniquely identify ext2 filesystems created by a machine.  This library
+The UUID library is used to generate unique identifiers for objects 
+that may be accessible beyond the local system.  This library
 generates UUIDs compatible with those created by the Open Software
 Foundation (OSF) Distributed Computing Environment (DCE) utility 
 .BR uuidgen .
@@ -56,15 +49,12 @@ of a name clash.
 .SH "CONFORMING TO"
 OSF DCE 1.1
 .SH AUTHOR
-.B libuuid
-was written by Theodore Y. Ts'o for the ext2 filesystem utilties.
+Theodore Y. Ts'o
 .SH AVAILABILITY
-.B libuuid
-is part of the e2fsprogs package and is available from
+The UUID library is part of the e2fsprogs package and is available from
 .UR http://e2fsprogs.sourceforge.net/
 http://e2fsprogs.sourceforge.net/
 .UE
-.UE
 .SH "SEE ALSO"
 .BR uuid_clear (3),
 .BR uuid_compare (3),

diff --git a/lib/uuid/uuidP.h b/lib/uuid/uuidP.h
index d207d3a5f95bf93bb93c1d6475180088edf3517d..4bf779d62ec6385f1ee1b09477b97c6b5ceaf7e1 100644 (file)
--- a/lib/uuid/uuidP.h
+++ b/lib/uuid/uuidP.h
@@ -61,7 +61,3 @@ struct uuid {
  */
 void uuid_pack(const struct uuid *uu, uuid_t ptr);
 void uuid_unpack(const uuid_t in, struct uuid *uu);
-
-
-
-

diff --git a/lib/uuid/uuid_clear.3.in b/lib/uuid/uuid_clear.3.in
index 6e32ae3b8d6060c77d46306bb3f5861de4ddccc1..92d2bf2fea247fa57db6692ea39d4326aa6fbe36 100644 (file)
--- a/lib/uuid/uuid_clear.3.in
+++ b/lib/uuid/uuid_clear.3.in
@@ -45,15 +45,16 @@ function sets the value of the supplied uuid variable
 .I uu
 to the NULL value.
 .SH AUTHOR
-.B uuid_clear
-was written by Theodore Y. Ts'o for the ext2 filesystem utilties.
+Theodore Y. Ts'o
 .SH AVAILABILITY
-.B uuid_clear
-is part of libuuid from the e2fsprogs package and is available from
-http://e2fsprogs.sourceforge.net.
+.UR http://e2fsprogs.sourceforge.net/
+http://e2fsprogs.sourceforge.net/
+.UE
 .SH "SEE ALSO"
-.BR libuuid (3),
+.BR uuid (3),
 .BR uuid_compare (3),
 .BR uuid_copy (3),
 .BR uuid_generate (3),
-.BR uuid_is_null (3)
+.BR uuid_is_null (3),
+.BR uuid_parse (3),
+.BR uuid_unparse (3)

diff --git a/lib/uuid/uuid_compare.3.in b/lib/uuid/uuid_compare.3.in
index 231736800924433d0bf9cf0dd30072561501ccf9..7f3296320df565e693b0d66877e75ef092e4b137 100644 (file)
--- a/lib/uuid/uuid_compare.3.in
+++ b/lib/uuid/uuid_compare.3.in
@@ -51,15 +51,16 @@ is found,  respectively, to be lexigraphically less than, equal, or
 greater than 
 .IR uu2 .
 .SH AUTHOR
-.B uuid_compare
-was written by Theodore Y. Ts'o for the ext2 filesystem utilties.
+Theodore Y. Ts'o
 .SH AVAILABILITY
-.B uuid_compare
-is part of libuuid from the e2fsprogs package and is available from
-http://e2fsprogs.sourceforge.net.
+.UR http://e2fsprogs.sourceforge.net/
+http://e2fsprogs.sourceforge.net/
+.UE
 .SH "SEE ALSO"
-.BR libuuid (3),
+.BR uuid (3),
 .BR uuid_clear (3),
 .BR uuid_copy (3),
 .BR uuid_generate (3),
-.BR uuid_is_null (3)
+.BR uuid_is_null (3),
+.BR uuid_parse (3),
+.BR uuid_unparse (3)

diff --git a/lib/uuid/uuid_copy.3.in b/lib/uuid/uuid_copy.3.in
index e4a5896f1b9976a825bbb9e6e5d0af1e654d4f0b..5f5e8c64d59d7c341e31543ea757649007da9de8 100644 (file)
--- a/lib/uuid/uuid_copy.3.in
+++ b/lib/uuid/uuid_copy.3.in
@@ -47,15 +47,16 @@ function copies the UUID variable
 The copied UUID is returned in the location pointed to by
 .IR dst .
 .SH AUTHOR
-.B uuid_copy
-was written by Theodore Y. Ts'o for the ext2 filesystem utilties.
+Theodore Y. Ts'o
 .SH AVAILABILITY
-.B uuid_copy
-is part of libuuid from the e2fsprogs package and is available from
-http://e2fsprogs.sourceforge.net.
+.UR http://e2fsprogs.sourceforge.net/
+http://e2fsprogs.sourceforge.net/
+.UE
 .SH "SEE ALSO"
-.BR libuuid (3),
+.BR uuid (3),
 .BR uuid_clear (3),
 .BR uuid_compare (3),
 .BR uuid_generate (3),
-.BR uuid_is_null (3)
+.BR uuid_is_null (3),
+.BR uuid_parse (3),
+.BR uuid_unparse (3)

diff --git a/lib/uuid/uuid_generate.3.in b/lib/uuid/uuid_generate.3.in
index 52acf72a68b896f4ab7bcbc1716ac5f64e71a31f..998e042980b560d7d8b060462fa08b265cad6404 100644 (file)
--- a/lib/uuid/uuid_generate.3.in
+++ b/lib/uuid/uuid_generate.3.in
@@ -87,18 +87,17 @@ The newly created UUID is returned in the memory location pointed to by
 .SH "CONFORMING TO"
 OSF DCE 1.1
 .SH AUTHOR
-.B uuid_generate
-was written by Theodore Y. Ts'o for the ext2 filesystem utilties.
+Theodore Y. Ts'o
 .SH AVAILABILITY
-.B uuid_generate
-is part of libuuid from the e2fsprogs package and is available from
-http://e2fsprogs.sourceforge.net.
+.UR http://e2fsprogs.sourceforge.net/
+http://e2fsprogs.sourceforge.net/
+.UE
 .SH "SEE ALSO"
-.BR libuuid (3),
+.BR uuid (3),
+.BR uuidgen (1),
 .BR uuid_clear (3),
 .BR uuid_compare (3),
 .BR uuid_copy (3),
-.BR uuidgen (1),
 .BR uuid_is_null (3),
 .BR uuid_parse (3),
 .BR uuid_time (3),

diff --git a/lib/uuid/uuid_is_null.3.in b/lib/uuid/uuid_is_null.3.in
index 59bb7af76929f409a32c0dc3eecb635681b5f216..e14288d4bf02eda622aed961f3b293b2276517f2 100644 (file)
--- a/lib/uuid/uuid_is_null.3.in
+++ b/lib/uuid/uuid_is_null.3.in
@@ -46,16 +46,17 @@ function compares the value of the supplied UUID variable
 to the NULL value.  If the value is equal to the NULL UUID, 1 is returned,
 otherwise 0 is returned.
 .SH AUTHOR
-.B uuid_is_null
-was written by Theodore Y. Ts'o for the ext2 filesystem utilties.
+Theodore Y. Ts'o
 .SH AVAILABILITY
-.B uuid_is_null
-is part of libuuid from the e2fsprogs package and is available from
-http://e2fsprogs.sourceforge.net.
+.UR http://e2fsprogs.sourceforge.net/
+http://e2fsprogs.sourceforge.net/
+.UE
 .SH "SEE ALSO"
-.BR libuuid (3),
+.BR uuid (3),
 .BR uuid_clear (3),
 .BR uuid_compare (3),
 .BR uuid_copy (3),
 .BR uuid_generate (3),
-.BR uuid_time (3)
+.BR uuid_time (3),
+.BR uuid_parse (3),
+.BR uuid_unparse (3)

diff --git a/lib/uuid/uuid_parse.3.in b/lib/uuid/uuid_parse.3.in
index a030397fbdf40c5cc4d36d5dbf857fd41e160895..f85acfae22c0b2c283bb6904a9213301d3a82ef1 100644 (file)
--- a/lib/uuid/uuid_parse.3.in
+++ b/lib/uuid/uuid_parse.3.in
@@ -55,14 +55,13 @@ otherwise \-1 is returned.
 .SH "CONFORMING TO"
 OSF DCE 1.1
 .SH AUTHOR
-.B uuid_parse
-was written by Theodore Y. Ts'o for the ext2 filesystem utilties.
+Theodore Y. Ts'o
 .SH AVAILABILITY
-.B uuid_parse
-is part of libuuid from the e2fsprogs package and is available from
-http://e2fsprogs.sourceforge.net.
+.UR http://e2fsprogs.sourceforge.net/
+http://e2fsprogs.sourceforge.net/
+.UE
 .SH "SEE ALSO"
-.BR libuuid (3),
+.BR uuid (3),
 .BR uuid_clear (3),
 .BR uuid_compare (3),
 .BR uuid_copy (3),

diff --git a/lib/uuid/uuid_time.3.in b/lib/uuid/uuid_time.3.in
index d798e6542e79a156bc2c61a228baf7ceb59fd44b..2a4c7000e1a2c137fbdfc4701a1963a326fe2085 100644 (file)
--- a/lib/uuid/uuid_time.3.in
+++ b/lib/uuid/uuid_time.3.in
@@ -41,14 +41,13 @@ uuid_time \- extract the time at which the UUID was created
 .SH DESCRIPTION
 The
 .B uuid_time
-function extracts the time at which the supplied UUID
+function extracts the time at which the supplied time-based UUID
 .I uu
-was created.  Note that the UUID creation time is encoded within the UUID,
-and this function can only reasonably expect to extract the creation time
-for UUIDs created with the
-.BR uuid_generate (3)
-function.  It may or may not work with UUIDs created by OSF DCE
-.BR uuidgen .
+was created.  Note that the UUID creation time is only encoded within 
+certain types of UUIDs.  This function can only reasonably expect to 
+extract the creation time for UUIDs created with the 
+.BR uuid_generate_time (3)
+function.  It may or may not work with UUIDs created by other mechanisms.
 .SH "RETURN VALUES"
 The time at which the UUID was created, in seconds since January 1, 1970 GMT
 (the epoch), is returned (see
@@ -59,14 +58,13 @@ the epoch, is also stored in the location pointed to by
 (see
 .BR gettimeofday "(2))."
 .SH AUTHOR
-.B uuid_time
-was written by Theodore Y. Ts'o for the ext2 filesystem utilties.
+Theodore Y. Ts'o
 .SH AVAILABILITY
-.B uuid_time
-is part of libuuid from the e2fsprogs package and is available from
-http://e2fsprogs.sourceforge.net.
+.UR http://e2fsprogs.sourceforge.net/
+http://e2fsprogs.sourceforge.net/
+.UE
 .SH "SEE ALSO"
-.BR libuuid (3),
+.BR uuid (3),
 .BR uuid_clear (3),
 .BR uuid_compare (3),
 .BR uuid_copy (3),

diff --git a/lib/uuid/uuid_unparse.3.in b/lib/uuid/uuid_unparse.3.in
index b5a5fcdea45ea3a054df6f734bf2f75b3d661c5b..f299f438348b2e7ee482d9ba8697583de27fd42e 100644 (file)
--- a/lib/uuid/uuid_unparse.3.in
+++ b/lib/uuid/uuid_unparse.3.in
@@ -60,16 +60,20 @@ hex digits is important then the functions
 and 
 .B uuid_unparse_lower
 may be used.
+.SH "CONFORMING TO"
+OSF DCE 1.1
 .SH AUTHOR
-.B uuid_unparse
-was written by Theodore Y. Ts'o for the ext2 filesystem utilties.
+Theodore Y. Ts'o
 .SH AVAILABILITY
-.B uuid_unparse
-is part of libuuid from the e2fsprogs package and is available from
-http://e2fsprogs.sourceforge.net.
+.UR http://e2fsprogs.sourceforge.net/
+http://e2fsprogs.sourceforge.net/
+.UE
 .SH "SEE ALSO"
-.BR libuuid (3),
+.BR uuid (3),
 .BR uuid_clear (3),
+.BR uuid_compare (3),
+.BR uuid_copy (3),
 .BR uuid_generate (3),
-.BR uuid_parse (3),
-.BR uuid_time (3)
+.BR uuid_time (3),
+.BR uuid_is_null (3),
+.BR uuid_parse (3)