Skip to contentSkip to conversation

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

PATCH In review Jan Mikkelsen 3 participants 3 messages May 18, 2022 – May 22, 2022 Kbuild

lore
Share & tools
lore
#0 lore raw

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

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.

Makefile.am 2022-04-07 12:47:10.961292000 +0200 renamed from Makefile.am.orig 2022-04-07 12:46:47.384178000 +0200 +1 -0
@@ -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 \

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.

#1 lore raw

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

From: Jan Mikkelsen <[email protected]...>

---
 doc/Makefile.am | 1 +
 1 file changed, 1 insertion(+)

I have reformatted this with git-format-patch to make the patch easier to apply. Also checked that this is indeed the only missing file currently.

doc/Makefile.am +1 -0
index affe1b90..c9e83750 100644
@@ -25,6 +25,7 @@ dist_doc_DATA = \
 
 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 \
Signature · 1 line
2.30.2
#2 lore raw
In reply to Jan Mikkelsen

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 <[email protected]...>
     Acked-by: Frank Lichtenheld <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg24394.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering