Skip to content

Commit

Permalink
update draft links in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kohenkatz committed Feb 15, 2023
1 parent ba6b224 commit a3cbee1
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
10 changes: 6 additions & 4 deletions README.md
Expand Up @@ -11,15 +11,17 @@ Package uuid provides a pure Go implementation of Universally Unique Identifiers
and parsing of UUIDs in different formats.

This package supports the following UUID versions:

* Version 1, based on timestamp and MAC address (RFC-4122)
* Version 3, based on MD5 hashing of a named value (RFC-4122)
* Version 4, based on random numbers (RFC-4122)
* Version 5, based on SHA-1 hashing of a named value (RFC-4122)

This package also supports experimental Universally Unique Identifier implementations based on a
[draft RFC](https://www.ietf.org/archive/id/draft-peabody-dispatch-new-uuid-format-04.html) that updates RFC-4122
* Version 6, a k-sortable id based on timestamp, and field-compatible with v1 (draft-peabody-dispatch-new-uuid-format, RFC-4122)
* Version 7, a k-sortable id based on timestamp (draft-peabody-dispatch-new-uuid-format, RFC-4122)
[draft RFC](https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-01.html) that updates RFC-4122:

* Version 6, a k-sortable id based on timestamp, and field-compatible with v1 (draft-ietf-uuidrev-rfc4122bis, RFC-4122)
* Version 7, a k-sortable id based on timestamp (draft-ietf-uuidrev-rfc4122bis, RFC-4122)

The v6 and v7 IDs are **not** considered a part of the stable API, and may be subject to behavior or API changes as part of minor releases
to this package. They will be updated as the draft RFC changes, and will become stable if and when the draft RFC is accepted.
Expand Down Expand Up @@ -92,4 +94,4 @@ func main() {

* [RFC-4122](https://tools.ietf.org/html/rfc4122)
* [DCE 1.1: Authentication and Security Services](http://pubs.opengroup.org/onlinepubs/9696989899/chap5.htm#tagcjh_08_02_01_01)
* [New UUID Formats RFC Draft (Peabody) Rev 04](https://www.ietf.org/archive/id/draft-peabody-dispatch-new-uuid-format-04.html#)
* [New UUID Formats RFC (uuidrev) Draft Rev 01](https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-01.html) (replaces earlier "peabody" drafts)
2 changes: 1 addition & 1 deletion generator.go
Expand Up @@ -356,7 +356,7 @@ func (g *Gen) getClockSequence(useUnixTSMs bool) (uint64, uint16, error) {
// releases until the spec is final.
func (g *Gen) NewV7() (UUID, error) {
var u UUID
/* https://www.ietf.org/archive/id/draft-peabody-dispatch-new-uuid-format-04.html#name-uuid-version-7
/* https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-01.html#name-uuid-version-7
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Expand Down
6 changes: 3 additions & 3 deletions uuid.go
Expand Up @@ -61,9 +61,9 @@ const (
V3 // Version 3 (namespace name-based)
V4 // Version 4 (random)
V5 // Version 5 (namespace name-based)
V6 // Version 6 (k-sortable timestamp and random data, field-compatible with v1) [peabody draft]
V7 // Version 7 (k-sortable timestamp and random data) [peabody draft]
_ // Version 8 (k-sortable timestamp, meant for custom implementations) [peabody draft] [not implemented]
V6 // Version 6 (k-sortable timestamp and random data, field-compatible with v1) [uuidrev draft]
V7 // Version 7 (k-sortable timestamp and random data) [uuidrev draft]
_ // Version 8 (k-sortable timestamp, meant for custom implementations) [uuidrev draft] [not implemented]
)

// UUID layout variants.
Expand Down

0 comments on commit a3cbee1

Please sign in to comment.