[Openvpn-devel] cipher-negotiation.rst missing from doc/Makefile.am

Message ID 2735E502-7F1F-48E9-8011-6740251E81DE@transactionware.com
State Accepted
Headers show
Series [Openvpn-devel] cipher-negotiation.rst missing from doc/Makefile.am | expand

Commit Message

Jan Mikkelsen May 18, 2022, 2:10 p.m. UTC
Hi,

The file doc/man-sections/cipher-negotiation.rst is missing from the from the openvpn-2.5.6 source tarball, making it hard to rebuild the openvpn(8) man page from source.

That file is also missing from the "openvpn_sections" assignment in doc/Makefile, meaning that the openvpn(8) man page won't get rebuilt if the man-sections/cipher-negotiation.rst file changes.

The underlying problem seems to be that doc/Makefile.am has not been updated according to the directions in the file:

# NOTE: Remember to add source .rst files to $(dist_noinst_DATA) below
# This could be automated with GNU Make, but we need BSD Make support

This has been forgotten for doc/man-sections/cipher-negotiation.rst. Trivial patch attached.



I reported this as a bug a while ago, but I’m not sure they get noticed.

For reference: https://community.openvpn.net/openvpn/attachment/ticket/1461

Thanks,

Jan M.

Comments

Gert Doering May 22, 2022, 1:55 p.m. UTC | #1
Thanks for spotting this & reporting, and sorry for not picking up
the trac ticket.  Sometimes we're too busy and only pay attention
to the openvpn-devel list & our IRC channel.

Tested with master and 2.5 "make dist".

Your patch has been applied to the master and release/2.5 branch.

commit 7c8dd98ec10f61c3b014b64c24090717cd6ebf05 (master)
commit 1294064e142d43b49df66296f8cd92de0698616d (release/2.5)
Author: Jan Mikkelsen
Date:   Wed May 18 20:37:15 2022 +0200

     cipher-negotiation.rst missing from doc/Makefile.am

     Signed-off-by: Jan Mikkelsen <janm@transactionware.com>
     Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
     Message-Id: <20220518183715.931-1-frank@lichtenheld.com>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg24394.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

--- doc/Makefile.am.orig        2022-04-07 12:46:47.384178000 +0200
+++ doc/Makefile.am     2022-04-07 12:47:10.961292000 +0200
@@ -25,6 +25,7 @@ 
 
 openvpn_sections = \
        man-sections/advanced-options.rst \
+       man-sections/cipher-negotiation.rst \
        man-sections/client-options.rst \
        man-sections/connection-profiles.rst \
        man-sections/encryption-options.rst \