Skip to content

man-page overhaul project - round 2

David Sommerseth openvpn-devel 2 versions – In review

Get series with b4
b4 am [email protected]...

Versions newest first · linked by author and title

  1. v2 Latest8 patches 11 repliesIn review
  2. v115 of 16 patches 1 replySuperseded

Patches in v2 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/8doc/man: Add an .rst formatted version of the man pagedoc/openvpn.8.rst doc/unsupported-options.rst+5782 -01 reply
2/8doc/man: Replace old man page with generated man page.gitignore INSTALL configure.ac +3 more+61 -76743 replies
3/8doc/man: Split up and reorganize main man pagedoc/Makefile.am doc/man-sections/advanced-options.rst doc/man-sections/client-options.rst +21 more+5542 -31 reply
4/8doc/man: Complete openvpn.8.rst splittingdoc/openvpn.8.rst+17 -55972 replies
5/8doc/man: Mark compression options as deprecateddoc/man-sections/protocol-options.rst+7 -81 reply
6/8doc/man: Adopt compression documentationdoc/man-sections/protocol-options.rst+43 -92 replies
7/8doc/man: Update --txqueuelen default setting (Now OS default)doc/man-sections/advanced-options.rst+1 -11 reply
8/8doc/man: Documentation for --bind-dev / VRFs on Linuxdoc/man-sections/network-config.rst doc/man-sections/virtual-routing-and-forwarding.rst doc/man-sections/vpn-network-options.rst+83 -02 replies

Reviews trailers per patch

All 8 patches have a Reviewed-by or Acked-by.

PatchGert Doering
1/8A-b
2/8A-b
3/8A-b
4/8A-b
5/8A-b
6/8A-b
7/8A-b
8/8A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v2 thread

Cover letter [Openvpn-devel] [PATCH v2 0/8] man-page overhaul project - round 2

Hi,

In the community meeting 2020-07-16, it was agreed to try to squash several commits and reduce the number of patches. In addition to split up the biggest patch into two parts to try to sneak everything into the mailing list without sending too large patches.

I've kept a few changes separate, as they are not strictly tied to this overhaul but these changes are important to get included.

Richard Bonhomme has also contributed with a lot of language improvements which now has been squashed into one of these commits below. Unfortunately this squashing removed him as the author of that commit, but I wanted to be sure he gets the proper credit somehow.

kind regards,

David Sommerseth
OpenVPN Inc

David Sommerseth (7):
doc/man: Add an .rst formatted version of the man page doc/man: Replace old man page with generated man page doc/man: Split up and reorganize main man page doc/man: Complete openvpn.8.rst splitting doc/man: Mark compression options as deprecated doc/man: Adopt compression documentation doc/man: Documentation for --bind-dev / VRFs on Linux

Richard Bonhomme (1):
doc/man: Update --txqueuelen default setting (Now OS default)

 .gitignore                                    |    1 +
 INSTALL                                       |    3 +-
 configure.ac                                  |   15 +-
 doc/Makefile.am                               |   56 +-
 doc/README.man                                |   23 +
 doc/man-sections/advanced-options.rst         |  107 +
 doc/man-sections/client-options.rst           |  354 +
 doc/man-sections/connection-profiles.rst      |   75 +
 doc/man-sections/encryption-options.rst       |  136 +
 doc/man-sections/examples.rst                 |  241 +
 doc/man-sections/generic-options.rst          |  436 +
 doc/man-sections/inline-files.rst             |   25 +
 doc/man-sections/link-options.rst             |  410 +
 doc/man-sections/log-options.rst              |   74 +
 doc/man-sections/management-options.rst       |  136 +
 doc/man-sections/network-config.rst           |   10 +
 doc/man-sections/pkcs11-options.rst           |   81 +
 doc/man-sections/plugin-options.rst           |   60 +
 doc/man-sections/protocol-options.rst         |  262 +
 doc/man-sections/proxy-options.rst            |   66 +
 doc/man-sections/renegotiation.rst            |   53 +
 doc/man-sections/script-options.rst           |  807 ++
 doc/man-sections/server-options.rst           |  769 ++
 doc/man-sections/signals.rst                  |   30 +
 doc/man-sections/tls-options.rst              |  643 ++
 doc/man-sections/unsupported-options.rst      |   33 +
 .../virtual-routing-and-forwarding.rst        |   78 +
 doc/man-sections/vpn-network-options.rst      |  535 ++
 doc/man-sections/windows-options.rst          |  245 +
 doc/openvpn.8                                 | 7659 -----------------
 doc/openvpn.8.rst                             |  169 +
 31 files changed, 5918 insertions(+), 7674 deletions(-)
 create mode 100644 doc/README.man
 create mode 100644 doc/man-sections/advanced-options.rst
 create mode 100644 doc/man-sections/client-options.rst
 create mode 100644 doc/man-sections/connection-profiles.rst
 create mode 100644 doc/man-sections/encryption-options.rst
 create mode 100644 doc/man-sections/examples.rst
 create mode 100644 doc/man-sections/generic-options.rst
 create mode 100644 doc/man-sections/inline-files.rst
 create mode 100644 doc/man-sections/link-options.rst
 create mode 100644 doc/man-sections/log-options.rst
 create mode 100644 doc/man-sections/management-options.rst
 create mode 100644 doc/man-sections/network-config.rst
 create mode 100644 doc/man-sections/pkcs11-options.rst
 create mode 100644 doc/man-sections/plugin-options.rst
 create mode 100644 doc/man-sections/protocol-options.rst
 create mode 100644 doc/man-sections/proxy-options.rst
 create mode 100644 doc/man-sections/renegotiation.rst
 create mode 100644 doc/man-sections/script-options.rst
 create mode 100644 doc/man-sections/server-options.rst
 create mode 100644 doc/man-sections/signals.rst
 create mode 100644 doc/man-sections/tls-options.rst
 create mode 100644 doc/man-sections/unsupported-options.rst
 create mode 100644 doc/man-sections/virtual-routing-and-forwarding.rst
 create mode 100644 doc/man-sections/vpn-network-options.rst
 create mode 100644 doc/man-sections/windows-options.rst
 delete mode 100644 doc/openvpn.8
 create mode 100644 doc/openvpn.8.rst
Signature · 1 line
2.26.0