Skip to content

Commit 0bd02e5

Browse files
authored
Fixed a typo
1 parent 58bb862 commit 0bd02e5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

DataCompressor/common/doc/overview.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ err_codes.h: Provides constants for common errors
88

99
Notes on usage:
1010
* IO_SIZE_BITS specifies the number of bits used for file-I/O-related operations. In particular, the size of return values for Read/Write functions in dependent libraries are based on it
11-
* If IO_SIZE_BITS is the same size as size_t, the Read/Write functions in dependent libraries do not work properly if the MSB of a size_t variable specifying the size to be read/Written is used. For example, if IO_SIZE_BITS is 32 and sizeof(size_t) is 4, the maximum size (parameter value) that the Read/Write function can work with is 2^31 - 1, i.e., the 32nd bit cannot be used. If it is used, the return value of the functions will be intereted as an error (since it is interpreted as a negative number)
12-
* Error codes have to be negative in order to distinguish them from return values which signal the amount of bytes read/written (which is positive)
11+
* If IO_SIZE_BITS is the same size as size_t, the Read/Write functions in dependent libraries do not work properly if the MSB of a size_t variable specifying the size to be read/written is used. For example, if IO_SIZE_BITS is 32 and sizeof(size_t) is 4, the maximum size (parameter value) that the Read/Write function can work with is 2^31 - 1, i.e., the 32nd bit cannot be used. If it is used, the return value of the functions will be intereted as an error (since it is interpreted as a negative number)
12+
* Error codes have to be negative in order to distinguish them from return values which signal the amount of bytes read/written (which is positive)

0 commit comments

Comments
 (0)