diff options
| author | Alejandro Colomar <alx@kernel.org> | 2024-11-17 18:47:53 +0100 |
|---|---|---|
| committer | Alejandro Colomar <alx@kernel.org> | 2024-11-17 21:51:23 +0100 |
| commit | 18e7c4597c4e72fa5210c7887273e363c456c9ee (patch) | |
| tree | 97cfd22e731a4c859ae71783d70943ff72e6cb60 /man/man3/rtnetlink.3 | |
| parent | 8fc6fdd8291d906e58a175b5e1b20da680aaeb4a (diff) | |
| download | man-pages-18e7c4597c4e.tar.gz | |
man/: Terminology consistency reforms (n, size, length)
Use 'length' for the lenght of a string.
Use 'n' for the number of elements.
Use 'size' for the number of bytes. (And in wide-character string
functions, 'size' also refers to the number of wide characters.)
The change is quite large, and I might have made some mistakes.
But overall, this should improve consistency in use of these terms.
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man/man3/rtnetlink.3')
| -rw-r--r-- | man/man3/rtnetlink.3 | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/man/man3/rtnetlink.3 b/man/man3/rtnetlink.3 index 52ded496cc..c55be3f5a1 100644 --- a/man/man3/rtnetlink.3 +++ b/man/man3/rtnetlink.3 @@ -28,8 +28,8 @@ Standard C library .BI "struct rtattr *RTA_NEXT(struct rtattr *" rta \ ", unsigned int " rtabuflen ); .P -.BI "unsigned int RTA_LENGTH(unsigned int " length ); -.BI "unsigned int RTA_SPACE(unsigned int "length ); +.BI "unsigned int RTA_LENGTH(unsigned int " size ); +.BI "unsigned int RTA_SPACE(unsigned int "size ); .fi .SH DESCRIPTION All @@ -44,7 +44,7 @@ returns true if .I rta points to a valid routing attribute; .I attrlen -is the running length of the attribute buffer. +is the running size of the attribute buffer. When not true then you must assume there are no more attributes in the message, even if .I attrlen @@ -54,7 +54,7 @@ is nonzero. returns a pointer to the start of this attribute's data. .P .BI RTA_PAYLOAD( rta ) -returns the length of this attribute's data. +returns the size of this attribute's data. .P .BI RTA_NEXT( rta ", " attrlen ) gets the next attribute after @@ -65,14 +65,14 @@ You should use .B RTA_OK to check the validity of the returned pointer. .P -.BI RTA_LENGTH( len ) -returns the length which is required for -.I len +.BI RTA_LENGTH( size ) +returns the size which is required for +.I size bytes of data plus the header. .P -.BI RTA_SPACE( len ) +.BI RTA_SPACE( size ) returns the amount of space which will be needed in a message with -.I len +.I size bytes of data. .SH STANDARDS Linux. |