diff options
| author | Gustaf Neumann <neumann@wu-wien.ac.at> | 2020-07-17 12:31:26 +0200 |
|---|---|---|
| committer | Dr. Matthias St. Pierre <matthias.st.pierre@ncp-e.com> | 2020-07-22 09:15:00 +0200 |
| commit | 490c87110cc1fd673604fa1b94d5538f9fd852bb (patch) | |
| tree | 3edd4a289e298a405dd7785fd1b21e81e8cd55e0 /util/find-doc-nits | |
| parent | bf19b64aaeeddd5463d911823f9e2c3c40091005 (diff) | |
| download | openssl-new-490c87110cc1fd673604fa1b94d5538f9fd852bb.tar.gz | |
Align documentation with recommendations of Linux Documentation Project
This change applies the recommendation of the Linux Documentation Project
to the documentation files of OpenSSL. Additionally, util/find-doc-nits
was updated accordingly.
The change follows a suggestion of mspncp on https://github.com/openssl/openssl/pull/12370
and incoporates the requested changes on the pull request
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from https://github.com/openssl/openssl/pull/12460)
Diffstat (limited to 'util/find-doc-nits')
| -rwxr-xr-x | util/find-doc-nits | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/util/find-doc-nits b/util/find-doc-nits index 3558180603..031076f05d 100755 --- a/util/find-doc-nits +++ b/util/find-doc-nits @@ -596,6 +596,7 @@ sub functionname_check { # This is from http://man7.org/linux/man-pages/man7/man-pages.7.html my %preferred_words = ( + '16bit' => '16-bit', 'a.k.a.' => 'aka', 'bitmask' => 'bit mask', 'builtin' => 'built-in', @@ -606,33 +607,40 @@ my %preferred_words = ( 'i-node' => 'inode', 'lower case' => 'lowercase', 'lower-case' => 'lowercase', + 'manpage' => 'man page', + 'non-blocking' => 'nonblocking', + 'non-default' => 'nondefault', + 'non-empty' => 'nonempty', + 'non-negative' => 'nonnegative', 'non-zero' => 'nonzero', 'path name' => 'pathname', + 'pre-allocated' => 'preallocated', 'pseudo-terminal' => 'pseudoterminal', - 'reserved port' => 'privileged port', - 'system port' => 'privileged port', - 'realtime' => 'real-time', 'real time' => 'real-time', + 'realtime' => 'real-time', + 'reserved port' => 'privileged port', 'runtime' => 'run time', 'saved group ID'=> 'saved set-group-ID', 'saved set-GID' => 'saved set-group-ID', - 'saved user ID' => 'saved set-user-ID', 'saved set-UID' => 'saved set-user-ID', + 'saved user ID' => 'saved set-user-ID', 'set-GID' => 'set-group-ID', - 'setgid' => 'set-group-ID', 'set-UID' => 'set-user-ID', + 'setgid' => 'set-group-ID', 'setuid' => 'set-user-ID', - 'super user' => 'superuser', - 'super-user' => 'superuser', + 'sub-system' => 'subsystem', 'super block' => 'superblock', 'super-block' => 'superblock', + 'super user' => 'superuser', + 'super-user' => 'superuser', + 'system port' => 'privileged port', 'time stamp' => 'timestamp', 'time zone' => 'timezone', 'upper case' => 'uppercase', 'upper-case' => 'uppercase', 'useable' => 'usable', - 'userspace' => 'user space', 'user name' => 'username', + 'userspace' => 'user space', 'zeroes' => 'zeros' ); |