Skip to content

Commit 2b160eb

Browse files
authored
Merge pull request #179 from ivanpanch/patch-1
Fix mistakes
2 parents 9134120 + 7fad3a4 commit 2b160eb

13 files changed

Lines changed: 18 additions & 18 deletions

File tree

doc/uuid/introduction.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
:idprefix: introduction_
55

6-
A UUID, or Universally unique identifier, is intended to uniquely identify information in a distributed environment without significant central coordination.
6+
A UUID, or universally unique identifier, is intended to uniquely identify information in a distributed environment without significant central coordination.
77
It can be used to tag objects with very short lifetimes, or to reliably identify very persistent objects across a network.
88

99
A formal definition for UUID can be found in https://datatracker.ietf.org/doc/rfc4122/[RFC 4122] and https://datatracker.ietf.org/doc/rfc9562/[RFC 9562].
@@ -18,7 +18,7 @@ UUIDs are inserted into documents from Microsoft Office programs.
1818
UUIDs identify audio or video streams in the Advanced Systems Format (ASF).
1919
UUIDs are also a basis for OIDs (object identifiers), and URNs (uniform resource name).
2020

21-
An attractive feature of UUIDs when compared to alternatives is their relative small size, of 128-bits, or 16-bytes.
21+
An attractive feature of UUIDs when compared to alternatives is their relative small size, of 128 bits, or 16 bytes.
2222
Another is that the creation of UUIDs does not require a centralized authority.
2323

2424
When UUIDs are generated by one of the defined mechanisms, they are either guaranteed to be unique, different from all other generated UUIDs

doc/uuid/name_generator_sha1.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ Returns: :: A name-based UUID version 5 produced from a digest of the namespace
5151

5252
Remarks: :: The characters of `name` are converted to a sequence of octets in the following manner:
5353
+
54-
* If `Ch` is `char` or `char8_t`, the characters are processed as octets directly;
55-
* If `Ch` is `wchar_t`, the characters are converted to `uint32_t` and then serialized to four octets each using little-endian representation;
54+
* If `Ch` is `char` or `char8_t`, the characters are processed as octets directly.
55+
* If `Ch` is `wchar_t`, the characters are converted to `uint32_t` and then serialized to four octets each using little-endian representation.
5656
* Otherwise, the character sequence is converted to UTF-8 and the result is processed as octets.
5757

5858
Example: ::

doc/uuid/time_generator_v1.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The atomic state is used by the generators to ensure that no duplicate UUIDs are
6363
time_generator_v1();
6464
```
6565

66-
Effects: :: Using entropy from `std::random_device`, generates a pseudorandom 48 bit node identifier in `node_` and a pseudorandom 14 bit clock sequence in `state_.clock_seq`. Initalizes `state_.timestamp` to zero.
66+
Effects: :: Using entropy from `std::random_device`, generates a pseudorandom 48 bit node identifier in `node_` and a pseudorandom 14 bit clock sequence in `state_.clock_seq`. Initializes `state_.timestamp` to zero.
6767

6868
Remarks: :: The multicast bit of `node_` is set to denote a local node identifier, as recommended in https://www.rfc-editor.org/rfc/rfc4122.html#section-4.5[RFC 4122 Section 4.5].
6969

doc/uuid/time_generator_v7.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,6 @@ Effects: ::
9797

9898
Remarks: :: `operator()` generates a monotonically increasing sequence of UUIDs, if the following requirements are met:
9999
+
100-
* The system clock never goes backwards;
101-
* The system clock has at least millisecond resolution;
102-
* No more than 64 UUIDs are generated per microsecond (no more than one every 16 nanoseconds.)
100+
* The system clock never goes backwards.
101+
* The system clock has at least millisecond resolution.
102+
* No more than 64 UUIDs are generated per microsecond (no more than one every 16 nanoseconds).

doc/uuid/uuid_clock.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ These values are specified in https://www.rfc-editor.org/rfc/rfc4122.html#sectio
4747
static time_point now() noexcept;
4848
```
4949

50-
Returns: :: The current system time (`std::chrono::system_clock::now()`, converted to `uuid_clock::time_point`.)
50+
Returns: :: The current system time (`std::chrono::system_clock::now()`, converted to `uuid_clock::time_point`).
5151

5252
=== from_sys
5353

doc/uuid/uuid_io.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ template<class Ch>
135135
bool to_chars( uuid const& u, Ch* first, Ch* last ) noexcept;
136136
```
137137

138-
Requires: :: `Ch` must be a character type (one of `char`, `wchar_t`, `char8_t`, `char16_t`, `char32_t`.)
138+
Requires: :: `Ch` must be a character type (one of `char`, `wchar_t`, `char8_t`, `char16_t`, `char32_t`).
139139

140140
Effects: :: If `last - first >= 36`, writes the string representation of `u` (exactly 36 characters, not null terminated) into the buffer starting at `first` and returns `true`. Otherwise, returns `false`.
141141

include/boost/uuid/detail/uuid_x86.ipp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ BOOST_FORCEINLINE void compare(uuid const& lhs, uuid const& rhs, std::uint32_t&
6565
// and depending on which way it is for, this will be the result of the operation. There are a few notes to consider:
6666
//
6767
// 1. Due to little endian byte order the first bytes go into the lower part of the xmm registers,
68-
// so the comparison results in the least significant bits will actually be the most signigicant for the final operation result.
68+
// so the comparison results in the least significant bits will actually be the most significant for the final operation result.
6969
// This means we have to determine which of the comparison results have the least significant bit on, and this is achieved with
7070
// the "(x - 1) ^ x" trick. With BMI, this will produce a single blsmsk instruction.
7171
// 2. Because there is only signed byte comparison until AVX-512, we have to invert byte comparison results whenever signs of the

include/boost/uuid/entropy_error.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ namespace uuids {
2121

2222
//! \brief Given boost::system::system_error is in a module that
2323
//! is not header-only, we define our own exception type
24-
//! to handle entropy provider errors instead,
24+
//! to handle entropy provider errors instead.
2525
class BOOST_SYMBOL_VISIBLE entropy_error : public std::runtime_error
2626
{
2727
public:

test/Jamfile.v2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ rule test_headers
5757

5858
alias test_headers : [ test_headers ] ;
5959

60-
# test inclucing all .hpp files in 2 translations units
60+
# test including all .hpp files in 2 translations units
6161
# to look for issues when using multiple translation units
62-
# eg. missing inline on a global functionstate is not missing
62+
# e.g. missing inline on a global functionstate is not missing
6363

6464
run test_include1.cpp test_include2.cpp ;
6565

test/cmake_install_test/main.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Copyright 2024 Peter Dimov.
22
// Distributed under the Boost Software License, Version 1.0.
3-
// https://www.boost.org/LICENSE_1_0.txt)
3+
// https://www.boost.org/LICENSE_1_0.txt
44

55
#include <boost/uuid.hpp>
66

0 commit comments

Comments
 (0)