OSSP CVS Repository

ossp - Check-in [3749]
Not logged in
[Honeypot]  [Browse]  [Home]  [Login]  [Reports
[Search]  [Ticket]  [Timeline
  [Patchset]  [Tagging/Branching

Check-in Number: 3749
Date: 2004-Jan-11 19:26:56 (local)
2004-Jan-11 18:26:56 (UTC)
User:rse
Branch:
Comment: finish API documentation
Tickets:
Inspections:
Files:
ossp-pkg/uuid/TODO      1.5 -> 1.6     0 inserted, 1 deleted
ossp-pkg/uuid/uuid.pod      1.5 -> 1.6     37 inserted, 2 deleted

ossp-pkg/uuid/TODO 1.5 -> 1.6

--- TODO 2004/01/11 07:38:35     1.5
+++ TODO 2004/01/11 18:26:56     1.6
@@ -1,4 +1,3 @@
-- write documentation uuid(3) [uuid.pod]
 - more platform support in uuid_mac.c?!
 - implement uuid -d (uuid_dump): dumping/decoding
 - global locking according to standard?


ossp-pkg/uuid/uuid.pod 1.5 -> 1.6

--- uuid.pod     2004/01/11 12:14:19     1.5
+++ uuid.pod     2004/01/11 18:26:56     1.6
@@ -232,7 +232,27 @@
 
 =item uuid_rc_t B<uuid_generate>(uuid_t *I<uuid>, unsigned int I<mode>, ...);
 
-FIXME
+Generates a new UUID in I<uuid> according to I<mode> and optional
+arguments (dependent on I<mode>).
+
+If I<mode> contains the C<UUID_VERSION1> bit, a DCE 1.1 variant UUID of
+version 1 is generated. Then optionally the bit C<UUID_MCASTRND> forces
+the use of random multi-cast MAC address instead of the real physical
+MAC address (the default). The UUID is generated out of the 60-bit current
+system time, a 12-bit clock sequence and the 48-bit MAC address.
+
+If I<mode> contains the C<UUID_VERSION3> bit, a DCE 1.1 variant UUID
+of version 3 is generated and two additional C<NUL>-terminated string
+arguments of type "C<const char *>" are expected: first a namespace,
+given as an internally pre-defined id (currently known are ids "C<DNS>",
+"C<URL>", "C<OID>", and "C<X500>") or a UUID in string representation.
+Second, a name string of arbitrary length. The UUID is generated out of
+the 128-bit MD5 from the concatenated octet stream of namespace UUID and name
+string.
+
+If I<mode> contains the C<UUID_VERSION4> bit, a DCE 1.1 variant UUID
+of version 4 is generated. The UUID is generated out of 128-bit random
+data.
 
 =item uuid_rc_t B<uuid_dump>(uuid_t *I<uuid>, char **I<str>);
 
@@ -240,7 +260,8 @@
 
 =item char *B<uuid_error>(uuid_rc_t I<rc>);
 
-FIXME
+Returns a constangt string representation corresponding to the
+return-code I<rc> for use in displaying B<OSSP uuid> errors.
 
 =back
 
@@ -297,5 +318,19 @@
 FreeBSD manual pages uuid(3) and uuidgen(2),
 http://www.freebsd.org/cgi/man.cgi?query=uuid&manpath=FreeBSD+5.2-RELEASE
 
+=back
+
+=head1 HISTORY
+
+B<OSSP uuid> was implemented in January 2004 by Ralf S. Engelschall
+E<lt>rse@engelschall.comE<gt>. It was prompted by the use of UUIDs
+in the B<OSSP as> and B<OpenPKG> projects. It is a clean room
+implementation intended to be strictly standards compliant and maximum
+portable.
+
+=head1 SEE ALSO
+
+uuid(1), uuid-config(1).
+
 =cut
 

CVSTrac 2.0.1