mbox series

[v1,00/10] Several fixes and improvements to the manual pages

Message ID 20240619232444.36444-1-alx@kernel.org (mailing list archive)
Headers show
Series Several fixes and improvements to the manual pages | expand

Message

Alejandro Colomar June 19, 2024, 11:24 p.m. UTC
Hi David,

Here's a set of fixes and improvements to the manual pages.  I'm
preparing a lot more, but I'll send these already to taste the waters.

Have a lovely day!
Alex

*** BLURB HERE ***

Alejandro Colomar (10):
  man/asymmetric-key.7: Use HISTORY instead of VERSIONS
  man: Use the LIBRARY section
  man: Fix TH arguments 4 and 5
  man: Update date in TH
  man: Use lowercase in TH 1st argument
  man: Escape dashes in TH
  man: Add SYNOPSYS section
  man: Improve formatting of SYNOPSIS of commands
  man/keyctl.1: Improve formatting
  man: Organize manual pages in subdirectories

 Makefile                                     |  10 +-
 man/{ => man1}/keyctl.1                      | 432 ++++++++++++++-----
 man/{ => man3}/find_key_by_type_and_name.3   |  11 +-
 man/{ => man3}/keyctl.3                      |  25 +-
 man/{ => man3}/keyctl_capabilities.3         |  13 +-
 man/{ => man3}/keyctl_chown.3                |  13 +-
 man/{ => man3}/keyctl_clear.3                |  13 +-
 man/{ => man3}/keyctl_describe.3             |  13 +-
 man/{ => man3}/keyctl_dh_compute.3           |  13 +-
 man/{ => man3}/keyctl_get_keyring_ID.3       |  13 +-
 man/{ => man3}/keyctl_get_persistent.3       |  13 +-
 man/{ => man3}/keyctl_get_security.3         |  13 +-
 man/{ => man3}/keyctl_instantiate.3          |  13 +-
 man/{ => man3}/keyctl_invalidate.3           |  13 +-
 man/{ => man3}/keyctl_join_session_keyring.3 |  13 +-
 man/{ => man3}/keyctl_link.3                 |  13 +-
 man/{ => man3}/keyctl_move.3                 |  13 +-
 man/{ => man3}/keyctl_pkey_decrypt.3         |   0
 man/{ => man3}/keyctl_pkey_encrypt.3         |  13 +-
 man/{ => man3}/keyctl_pkey_query.3           |  13 +-
 man/{ => man3}/keyctl_pkey_sign.3            |  13 +-
 man/{ => man3}/keyctl_pkey_verify.3          |   0
 man/{ => man3}/keyctl_read.3                 |  13 +-
 man/{ => man3}/keyctl_restrict_keyring.3     |  13 +-
 man/{ => man3}/keyctl_revoke.3               |  13 +-
 man/{ => man3}/keyctl_search.3               |  15 +-
 man/{ => man3}/keyctl_session_to_parent.3    |  13 +-
 man/{ => man3}/keyctl_set_reqkey_keyring.3   |  13 +-
 man/{ => man3}/keyctl_set_timeout.3          |  13 +-
 man/{ => man3}/keyctl_setperm.3              |  13 +-
 man/{ => man3}/keyctl_update.3               |  13 +-
 man/{ => man3}/keyctl_watch_key.3            |  13 +-
 man/{ => man3}/recursive_key_scan.3          |  11 +-
 man/{ => man5}/key.dns_resolver.conf.5       |   2 +-
 man/{ => man5}/request-key.conf.5            |   2 +-
 man/{ => man7}/asymmetric-key.7              |   4 +-
 man/{ => man7}/keyutils.7                    |  26 +-
 man/{ => man8}/key.dns_resolver.8            |   2 +-
 man/{ => man8}/request-key.8                 |  14 +-
 39 files changed, 498 insertions(+), 381 deletions(-)
 rename man/{ => man1}/keyctl.1 (89%)
 rename man/{ => man3}/find_key_by_type_and_name.3 (92%)
 rename man/{ => man3}/keyctl.3 (89%)
 rename man/{ => man3}/keyctl_capabilities.3 (94%)
 rename man/{ => man3}/keyctl_chown.3 (91%)
 rename man/{ => man3}/keyctl_clear.3 (89%)
 rename man/{ => man3}/keyctl_describe.3 (93%)
 rename man/{ => man3}/keyctl_dh_compute.3 (95%)
 rename man/{ => man3}/keyctl_get_keyring_ID.3 (92%)
 rename man/{ => man3}/keyctl_get_persistent.3 (93%)
 rename man/{ => man3}/keyctl_get_security.3 (93%)
 rename man/{ => man3}/keyctl_instantiate.3 (96%)
 rename man/{ => man3}/keyctl_invalidate.3 (90%)
 rename man/{ => man3}/keyctl_join_session_keyring.3 (91%)
 rename man/{ => man3}/keyctl_link.3 (92%)
 rename man/{ => man3}/keyctl_move.3 (92%)
 rename man/{ => man3}/keyctl_pkey_decrypt.3 (100%)
 rename man/{ => man3}/keyctl_pkey_encrypt.3 (94%)
 rename man/{ => man3}/keyctl_pkey_query.3 (94%)
 rename man/{ => man3}/keyctl_pkey_sign.3 (95%)
 rename man/{ => man3}/keyctl_pkey_verify.3 (100%)
 rename man/{ => man3}/keyctl_read.3 (94%)
 rename man/{ => man3}/keyctl_restrict_keyring.3 (91%)
 rename man/{ => man3}/keyctl_revoke.3 (89%)
 rename man/{ => man3}/keyctl_search.3 (93%)
 rename man/{ => man3}/keyctl_session_to_parent.3 (91%)
 rename man/{ => man3}/keyctl_set_reqkey_keyring.3 (93%)
 rename man/{ => man3}/keyctl_set_timeout.3 (90%)
 rename man/{ => man3}/keyctl_setperm.3 (94%)
 rename man/{ => man3}/keyctl_update.3 (91%)
 rename man/{ => man3}/keyctl_watch_key.3 (95%)
 rename man/{ => man3}/recursive_key_scan.3 (95%)
 rename man/{ => man5}/key.dns_resolver.conf.5 (95%)
 rename man/{ => man5}/request-key.conf.5 (98%)
 rename man/{ => man7}/asymmetric-key.7 (99%)
 rename man/{ => man7}/keyutils.7 (89%)
 rename man/{ => man8}/key.dns_resolver.8 (95%)
 rename man/{ => man8}/request-key.8 (92%)

Range-diff against v0:
 -:  ------- >  1:  ec0c2fa man/asymmetric-key.7: Use HISTORY instead of VERSIONS
 -:  ------- >  2:  8f02c27 man: Use the LIBRARY section
 -:  ------- >  3:  e3e616f man: Fix TH arguments 4 and 5
 -:  ------- >  4:  7762f59 man: Update date in TH
 -:  ------- >  5:  7294951 man: Use lowercase in TH 1st argument
 -:  ------- >  6:  3d6ef97 man: Escape dashes in TH
 -:  ------- >  7:  5794916 man: Add SYNOPSYS section
 -:  ------- >  8:  30c25a7 man: Improve formatting of SYNOPSIS of commands
 -:  ------- >  9:  ae1e052 man/keyctl.1: Improve formatting
 -:  ------- > 10:  93e44ce man: Organize manual pages in subdirectories

Comments

Alejandro Colomar July 10, 2024, 8:45 p.m. UTC | #1
On Thu, Jun 20, 2024 at 01:24:49AM GMT, Alejandro Colomar wrote:
> Hi David,
> 
> Here's a set of fixes and improvements to the manual pages.  I'm
> preparing a lot more, but I'll send these already to taste the waters.

Ping.

> 
> Have a lovely day!
> Alex
> 
> *** BLURB HERE ***
> 
> Alejandro Colomar (10):
>   man/asymmetric-key.7: Use HISTORY instead of VERSIONS
>   man: Use the LIBRARY section
>   man: Fix TH arguments 4 and 5
>   man: Update date in TH
>   man: Use lowercase in TH 1st argument
>   man: Escape dashes in TH
>   man: Add SYNOPSYS section
>   man: Improve formatting of SYNOPSIS of commands
>   man/keyctl.1: Improve formatting
>   man: Organize manual pages in subdirectories
> 
>  Makefile                                     |  10 +-
>  man/{ => man1}/keyctl.1                      | 432 ++++++++++++++-----
>  man/{ => man3}/find_key_by_type_and_name.3   |  11 +-
>  man/{ => man3}/keyctl.3                      |  25 +-
>  man/{ => man3}/keyctl_capabilities.3         |  13 +-
>  man/{ => man3}/keyctl_chown.3                |  13 +-
>  man/{ => man3}/keyctl_clear.3                |  13 +-
>  man/{ => man3}/keyctl_describe.3             |  13 +-
>  man/{ => man3}/keyctl_dh_compute.3           |  13 +-
>  man/{ => man3}/keyctl_get_keyring_ID.3       |  13 +-
>  man/{ => man3}/keyctl_get_persistent.3       |  13 +-
>  man/{ => man3}/keyctl_get_security.3         |  13 +-
>  man/{ => man3}/keyctl_instantiate.3          |  13 +-
>  man/{ => man3}/keyctl_invalidate.3           |  13 +-
>  man/{ => man3}/keyctl_join_session_keyring.3 |  13 +-
>  man/{ => man3}/keyctl_link.3                 |  13 +-
>  man/{ => man3}/keyctl_move.3                 |  13 +-
>  man/{ => man3}/keyctl_pkey_decrypt.3         |   0
>  man/{ => man3}/keyctl_pkey_encrypt.3         |  13 +-
>  man/{ => man3}/keyctl_pkey_query.3           |  13 +-
>  man/{ => man3}/keyctl_pkey_sign.3            |  13 +-
>  man/{ => man3}/keyctl_pkey_verify.3          |   0
>  man/{ => man3}/keyctl_read.3                 |  13 +-
>  man/{ => man3}/keyctl_restrict_keyring.3     |  13 +-
>  man/{ => man3}/keyctl_revoke.3               |  13 +-
>  man/{ => man3}/keyctl_search.3               |  15 +-
>  man/{ => man3}/keyctl_session_to_parent.3    |  13 +-
>  man/{ => man3}/keyctl_set_reqkey_keyring.3   |  13 +-
>  man/{ => man3}/keyctl_set_timeout.3          |  13 +-
>  man/{ => man3}/keyctl_setperm.3              |  13 +-
>  man/{ => man3}/keyctl_update.3               |  13 +-
>  man/{ => man3}/keyctl_watch_key.3            |  13 +-
>  man/{ => man3}/recursive_key_scan.3          |  11 +-
>  man/{ => man5}/key.dns_resolver.conf.5       |   2 +-
>  man/{ => man5}/request-key.conf.5            |   2 +-
>  man/{ => man7}/asymmetric-key.7              |   4 +-
>  man/{ => man7}/keyutils.7                    |  26 +-
>  man/{ => man8}/key.dns_resolver.8            |   2 +-
>  man/{ => man8}/request-key.8                 |  14 +-
>  39 files changed, 498 insertions(+), 381 deletions(-)
>  rename man/{ => man1}/keyctl.1 (89%)
>  rename man/{ => man3}/find_key_by_type_and_name.3 (92%)
>  rename man/{ => man3}/keyctl.3 (89%)
>  rename man/{ => man3}/keyctl_capabilities.3 (94%)
>  rename man/{ => man3}/keyctl_chown.3 (91%)
>  rename man/{ => man3}/keyctl_clear.3 (89%)
>  rename man/{ => man3}/keyctl_describe.3 (93%)
>  rename man/{ => man3}/keyctl_dh_compute.3 (95%)
>  rename man/{ => man3}/keyctl_get_keyring_ID.3 (92%)
>  rename man/{ => man3}/keyctl_get_persistent.3 (93%)
>  rename man/{ => man3}/keyctl_get_security.3 (93%)
>  rename man/{ => man3}/keyctl_instantiate.3 (96%)
>  rename man/{ => man3}/keyctl_invalidate.3 (90%)
>  rename man/{ => man3}/keyctl_join_session_keyring.3 (91%)
>  rename man/{ => man3}/keyctl_link.3 (92%)
>  rename man/{ => man3}/keyctl_move.3 (92%)
>  rename man/{ => man3}/keyctl_pkey_decrypt.3 (100%)
>  rename man/{ => man3}/keyctl_pkey_encrypt.3 (94%)
>  rename man/{ => man3}/keyctl_pkey_query.3 (94%)
>  rename man/{ => man3}/keyctl_pkey_sign.3 (95%)
>  rename man/{ => man3}/keyctl_pkey_verify.3 (100%)
>  rename man/{ => man3}/keyctl_read.3 (94%)
>  rename man/{ => man3}/keyctl_restrict_keyring.3 (91%)
>  rename man/{ => man3}/keyctl_revoke.3 (89%)
>  rename man/{ => man3}/keyctl_search.3 (93%)
>  rename man/{ => man3}/keyctl_session_to_parent.3 (91%)
>  rename man/{ => man3}/keyctl_set_reqkey_keyring.3 (93%)
>  rename man/{ => man3}/keyctl_set_timeout.3 (90%)
>  rename man/{ => man3}/keyctl_setperm.3 (94%)
>  rename man/{ => man3}/keyctl_update.3 (91%)
>  rename man/{ => man3}/keyctl_watch_key.3 (95%)
>  rename man/{ => man3}/recursive_key_scan.3 (95%)
>  rename man/{ => man5}/key.dns_resolver.conf.5 (95%)
>  rename man/{ => man5}/request-key.conf.5 (98%)
>  rename man/{ => man7}/asymmetric-key.7 (99%)
>  rename man/{ => man7}/keyutils.7 (89%)
>  rename man/{ => man8}/key.dns_resolver.8 (95%)
>  rename man/{ => man8}/request-key.8 (92%)
> 
> Range-diff against v0:
>  -:  ------- >  1:  ec0c2fa man/asymmetric-key.7: Use HISTORY instead of VERSIONS
>  -:  ------- >  2:  8f02c27 man: Use the LIBRARY section
>  -:  ------- >  3:  e3e616f man: Fix TH arguments 4 and 5
>  -:  ------- >  4:  7762f59 man: Update date in TH
>  -:  ------- >  5:  7294951 man: Use lowercase in TH 1st argument
>  -:  ------- >  6:  3d6ef97 man: Escape dashes in TH
>  -:  ------- >  7:  5794916 man: Add SYNOPSYS section
>  -:  ------- >  8:  30c25a7 man: Improve formatting of SYNOPSIS of commands
>  -:  ------- >  9:  ae1e052 man/keyctl.1: Improve formatting
>  -:  ------- > 10:  93e44ce man: Organize manual pages in subdirectories
> -- 
> 2.45.2
>