Skip to contentSkip to conversation

dist: add more missing files only used in the MSVC build

PATCH In review Frank Lichtenheld 2 participants 13 messages Jun 14, 2023 – Jun 21, 2023 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 dist: add more missing files only used in the MSVC build

So it is possible to build with MSVC from the release tarballs.

Fixes #344.

---
 build/msvc/msvc-generate/Makefile.am | 1 +
 src/openvpn/Makefile.am              | 3 ++-
 2 files changed, 3 insertions(+), 1 deletion(-)
build/msvc/msvc-generate/Makefile.am +1 -0
index 9d04326d..fe13b370 100644
@@ -13,6 +13,7 @@ MAINTAINERCLEANFILES = \
 	$(srcdir)/Makefile.in
 
 dist_noinst_DATA = \
+	git-version.py \
 	msvc-generate.vcxproj \
 	Makefile.mak \
 	msvc-generate.js \
src/openvpn/Makefile.am +2 -1
index a8e44528..2f979914 100644
@@ -16,7 +16,8 @@ MAINTAINERCLEANFILES = \
 
 EXTRA_DIST = \
 	openvpn.vcxproj \
-	openvpn.manifest
+	openvpn.manifest \
+	vcpkg.json
 
 AM_CPPFLAGS = \
 	-I$(top_srcdir)/include \
Signature · 1 line
2.34.1
#1 lore raw

PATCH 2/2 vcpkg-ports/pkcs11-helper: rename patches to make file names shorter

Remove the number prefixes we do not use anyway.

And then rename Allow-the-build-to-succeed-if-configured-with-disabl.patch to make it short enough that it can fit in a tar archive
built with --old-archive. Otherwise make dist might not include it:

tar: openvpn-2.7_git/contrib/vcpkg-ports/pkcs11-helper/Allow-the-build-to-succeed-if-configured-with-disabl.patch:
file name is too long (max 99); not dumped

---
 ...ith-disabl.patch => Fix-build-with-disable-shared.patch} | 0
 ...nSSL.patch => config-w32-vc.h.in-indicate-OpenSSL.patch} | 0
 ...ake.patch => nmake-compatibility-with-vcpkg-nmake.patch} | 0
 contrib/vcpkg-ports/pkcs11-helper/portfile.cmake            | 6 +++---
 4 files changed, 3 insertions(+), 3 deletions(-)
 rename contrib/vcpkg-ports/pkcs11-helper/{0001-Allow-the-build-to-succeed-if-configured-with-disabl.patch => Fix-build-with-disable-shared.patch} (100%)
 rename contrib/vcpkg-ports/pkcs11-helper/{0002-config-w32-vc.h.in-indicate-OpenSSL.patch => config-w32-vc.h.in-indicate-OpenSSL.patch} (100%)
 rename contrib/vcpkg-ports/pkcs11-helper/{0001-nmake-compatibility-with-vcpkg-nmake.patch => nmake-compatibility-with-vcpkg-nmake.patch} (100%)
contrib/vcpkg-ports/pkcs11-helper/Fix-build-with-disable-shared.patch renamed from contrib/vcpkg-ports/pkcs11-helper/0001-Allow-the-build-to-succeed-if-configured-with-disabl.patch +0 -0
similarity index 100%
rename from contrib/vcpkg-ports/pkcs11-helper/0001-Allow-the-build-to-succeed-if-configured-with-disabl.patch
rename to contrib/vcpkg-ports/pkcs11-helper/Fix-build-with-disable-shared.patch
contrib/vcpkg-ports/pkcs11-helper/config-w32-vc.h.in-indicate-OpenSSL.patch renamed from contrib/vcpkg-ports/pkcs11-helper/0002-config-w32-vc.h.in-indicate-OpenSSL.patch +0 -0
similarity index 100%
rename from contrib/vcpkg-ports/pkcs11-helper/0002-config-w32-vc.h.in-indicate-OpenSSL.patch
rename to contrib/vcpkg-ports/pkcs11-helper/config-w32-vc.h.in-indicate-OpenSSL.patch
contrib/vcpkg-ports/pkcs11-helper/nmake-compatibility-with-vcpkg-nmake.patch renamed from contrib/vcpkg-ports/pkcs11-helper/0001-nmake-compatibility-with-vcpkg-nmake.patch +0 -0
similarity index 100%
rename from contrib/vcpkg-ports/pkcs11-helper/0001-nmake-compatibility-with-vcpkg-nmake.patch
rename to contrib/vcpkg-ports/pkcs11-helper/nmake-compatibility-with-vcpkg-nmake.patch
contrib/vcpkg-ports/pkcs11-helper/portfile.cmake +3 -3
index 67e9a2bf..47919bc6 100644
@@ -11,9 +11,9 @@ vcpkg_extract_source_archive_ex(
     ARCHIVE ${ARCHIVE}
     REF ${VERSION}
     PATCHES
-        0001-nmake-compatibility-with-vcpkg-nmake.patch
-        0002-config-w32-vc.h.in-indicate-OpenSSL.patch
-        0001-Allow-the-build-to-succeed-if-configured-with-disabl.patch
+        nmake-compatibility-with-vcpkg-nmake.patch
+        config-w32-vc.h.in-indicate-OpenSSL.patch
+        Fix-build-with-disable-shared.patch
         pkcs11-helper-001-RFC7512.patch
         pkcs11-helper-002-dynamic_loader_flags.patch
 )
Signature · 1 line
2.34.1
#3 lore raw

cover Various dist-related fixes

In reply to Frank Lichtenheld

After this series the diff between git and the tarball is:

Only in ../: dev-tools
Only in openvpn-2.7_git/doc: openvpn.8
Only in openvpn-2.7_git/doc: openvpn.8.html Only in openvpn-2.7_git/doc: openvpn-examples.5 Only in openvpn-2.7_git/doc: openvpn-examples.5.html Only in ../: .git
Only in ../: .git-blame-ignore-revs
Only in ../: .github
Only in openvpn-2.7_git/include: openvpn-plugin.h Only in ../m4: .keep
Only in ../: .mailmap
Only in openvpn-2.7_git/sample/sample-plugins: Makefile Only in ../: .svncommitters
Only in ../: .travis
Only in ../: .travis.yml

That looks reasonable to me.

Frank Lichtenheld (4):
dist: add more missing files only used in the MSVC build vcpkg-ports/pkcs11-helper: rename patches to make file names shorter
unit_tests: Add missing cert_data.h to source list for unit tests
dist: Include all documentation in distribution

 Makefile.am                                   |  5 ++++-
 build/msvc/msvc-generate/Makefile.am          |  1 +
 ...ch => Fix-build-with-disable-shared.patch} |  0
 ...config-w32-vc.h.in-indicate-OpenSSL.patch} |  0
 ...make-compatibility-with-vcpkg-nmake.patch} |  0
 .../vcpkg-ports/pkcs11-helper/portfile.cmake  |  6 +++---
 doc/Makefile.am                               |  9 +++++++-
 doc/doxygen/Makefile.am                       | 21 ++++++++++++++++++-
 src/openvpn/Makefile.am                       |  3 ++-
 tests/unit_tests/openvpn/Makefile.am          |  4 ++--
 10 files changed, 40 insertions(+), 9 deletions(-)
 rename contrib/vcpkg-ports/pkcs11-helper/{0001-Allow-the-build-to-succeed-if-configured-with-disabl.patch => Fix-build-with-disable-shared.patch} (100%)
 rename contrib/vcpkg-ports/pkcs11-helper/{0002-config-w32-vc.h.in-indicate-OpenSSL.patch => config-w32-vc.h.in-indicate-OpenSSL.patch} (100%)
 rename contrib/vcpkg-ports/pkcs11-helper/{0001-nmake-compatibility-with-vcpkg-nmake.patch => nmake-compatibility-with-vcpkg-nmake.patch} (100%)
Signature · 1 line
2.34.1
#4 lore raw

PATCH 1/4 dist: add more missing files only used in the MSVC build

So it is possible to build with MSVC from the release tarballs.

Fixes #344.

---
 build/msvc/msvc-generate/Makefile.am | 1 +
 src/openvpn/Makefile.am              | 3 ++-
 2 files changed, 3 insertions(+), 1 deletion(-)

Note: unchanged from previous submission

build/msvc/msvc-generate/Makefile.am +1 -0
index 9d04326d..fe13b370 100644
@@ -13,6 +13,7 @@ MAINTAINERCLEANFILES = \
 	$(srcdir)/Makefile.in
 
 dist_noinst_DATA = \
+	git-version.py \
 	msvc-generate.vcxproj \
 	Makefile.mak \
 	msvc-generate.js \
src/openvpn/Makefile.am +2 -1
index a8e44528..2f979914 100644
@@ -16,7 +16,8 @@ MAINTAINERCLEANFILES = \
 
 EXTRA_DIST = \
 	openvpn.vcxproj \
-	openvpn.manifest
+	openvpn.manifest \
+	vcpkg.json
 
 AM_CPPFLAGS = \
 	-I$(top_srcdir)/include \
Signature · 1 line
2.34.1
#6 lore raw

PATCH 2/4 vcpkg-ports/pkcs11-helper: rename patches to make file names shorter

In reply to Frank Lichtenheld

Remove the number prefixes we do not use anyway.

And then rename Allow-the-build-to-succeed-if-configured-with-disabl.patch to make it short enough that it can fit in a tar archive
built with --old-archive. Otherwise make dist might not include it:

tar: openvpn-2.7_git/contrib/vcpkg-ports/pkcs11-helper/Allow-the-build-to-succeed-if-configured-with-disabl.patch:
file name is too long (max 99); not dumped

---
 ...ith-disabl.patch => Fix-build-with-disable-shared.patch} | 0
 ...nSSL.patch => config-w32-vc.h.in-indicate-OpenSSL.patch} | 0
 ...ake.patch => nmake-compatibility-with-vcpkg-nmake.patch} | 0
 contrib/vcpkg-ports/pkcs11-helper/portfile.cmake            | 6 +++---
 4 files changed, 3 insertions(+), 3 deletions(-)
 rename contrib/vcpkg-ports/pkcs11-helper/{0001-Allow-the-build-to-succeed-if-configured-with-disabl.patch => Fix-build-with-disable-shared.patch} (100%)
 rename contrib/vcpkg-ports/pkcs11-helper/{0002-config-w32-vc.h.in-indicate-OpenSSL.patch => config-w32-vc.h.in-indicate-OpenSSL.patch} (100%)
 rename contrib/vcpkg-ports/pkcs11-helper/{0001-nmake-compatibility-with-vcpkg-nmake.patch => nmake-compatibility-with-vcpkg-nmake.patch} (100%)

Note: unchanged from previous submission

contrib/vcpkg-ports/pkcs11-helper/Fix-build-with-disable-shared.patch renamed from contrib/vcpkg-ports/pkcs11-helper/0001-Allow-the-build-to-succeed-if-configured-with-disabl.patch +0 -0
similarity index 100%
rename from contrib/vcpkg-ports/pkcs11-helper/0001-Allow-the-build-to-succeed-if-configured-with-disabl.patch
rename to contrib/vcpkg-ports/pkcs11-helper/Fix-build-with-disable-shared.patch
contrib/vcpkg-ports/pkcs11-helper/config-w32-vc.h.in-indicate-OpenSSL.patch renamed from contrib/vcpkg-ports/pkcs11-helper/0002-config-w32-vc.h.in-indicate-OpenSSL.patch +0 -0
similarity index 100%
rename from contrib/vcpkg-ports/pkcs11-helper/0002-config-w32-vc.h.in-indicate-OpenSSL.patch
rename to contrib/vcpkg-ports/pkcs11-helper/config-w32-vc.h.in-indicate-OpenSSL.patch
contrib/vcpkg-ports/pkcs11-helper/nmake-compatibility-with-vcpkg-nmake.patch renamed from contrib/vcpkg-ports/pkcs11-helper/0001-nmake-compatibility-with-vcpkg-nmake.patch +0 -0
similarity index 100%
rename from contrib/vcpkg-ports/pkcs11-helper/0001-nmake-compatibility-with-vcpkg-nmake.patch
rename to contrib/vcpkg-ports/pkcs11-helper/nmake-compatibility-with-vcpkg-nmake.patch
contrib/vcpkg-ports/pkcs11-helper/portfile.cmake +3 -3
index 67e9a2bf..47919bc6 100644
@@ -11,9 +11,9 @@ vcpkg_extract_source_archive_ex(
     ARCHIVE ${ARCHIVE}
     REF ${VERSION}
     PATCHES
-        0001-nmake-compatibility-with-vcpkg-nmake.patch
-        0002-config-w32-vc.h.in-indicate-OpenSSL.patch
-        0001-Allow-the-build-to-succeed-if-configured-with-disabl.patch
+        nmake-compatibility-with-vcpkg-nmake.patch
+        config-w32-vc.h.in-indicate-OpenSSL.patch
+        Fix-build-with-disable-shared.patch
         pkcs11-helper-001-RFC7512.patch
         pkcs11-helper-002-dynamic_loader_flags.patch
 )
Signature · 1 line
2.34.1
#9 lore raw

PATCH 3/4 unit_tests: Add missing cert_data.h to source list for unit tests

In reply to Frank Lichtenheld

Document the dependency. Also fixes cert_data.h missing from distribution.

---
 tests/unit_tests/openvpn/Makefile.am | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
tests/unit_tests/openvpn/Makefile.am +2 -2
index ccd0e37b..dbf658ac 100644
@@ -162,7 +162,7 @@ cryptoapi_testdriver_CFLAGS  = @TEST_CFLAGS@ \
 cryptoapi_testdriver_LDFLAGS = @TEST_LDFLAGS@ \
 	$(OPTIONAL_CRYPTO_LIBS) -lcrypt32 -lncrypt
 cryptoapi_testdriver_SOURCES = test_cryptoapi.c mock_msg.c \
-	pkey_test_utils.c \
+	pkey_test_utils.c cert_data.h \
 	$(top_srcdir)/src/openvpn/xkey_helper.c \
 	$(top_srcdir)/src/openvpn/xkey_provider.c \
 	$(top_srcdir)/src/openvpn/buffer.c \
@@ -180,7 +180,7 @@ pkcs11_testdriver_CFLAGS  = @TEST_CFLAGS@ \
 pkcs11_testdriver_LDFLAGS = @TEST_LDFLAGS@ \
 	$(OPTIONAL_CRYPTO_LIBS)
 pkcs11_testdriver_SOURCES = test_pkcs11.c mock_msg.c \
-	pkey_test_utils.c mock_get_random.c \
+	pkey_test_utils.c cert_data.h mock_get_random.c \
 	$(top_srcdir)/src/openvpn/xkey_helper.c \
 	$(top_srcdir)/src/openvpn/xkey_provider.c \
 	$(top_srcdir)/src/openvpn/argv.c \
Signature · 1 line
2.34.1
#11 lore raw

PATCH 4/4 dist: Include all documentation in distribution

In reply to Frank Lichtenheld

No need to deprive tar ball users of this information.

---
 Makefile.am             |  5 ++++-
 doc/Makefile.am         |  9 ++++++++-
 doc/doxygen/Makefile.am | 21 ++++++++++++++++++++-
 3 files changed, 32 insertions(+), 3 deletions(-)
Makefile.am +4 -1
index 297c3399..27da974d 100644
@@ -62,8 +62,11 @@ dist_doc_DATA = \
 dist_noinst_DATA = \
 	.gitignore \
 	.gitattributes \
+	CONTRIBUTING.rst \
 	PORTS \
-	README.mbedtls \
+	README.dco.md \
+	README.ec \
+	README.wolfssl \
 	openvpn.sln
 
 dist_noinst_HEADERS = \
doc/Makefile.am +8 -1
index bb9c935d..d8ffe2e0 100644
@@ -54,12 +54,19 @@ openvpn_examples_sections = \
 	man-sections/examples.rst
 
 dist_noinst_DATA = \
-	README.plugins interactive-service-notes.rst \
+	android.txt \
+	interactive-service-notes.rst \
+	keying-material-exporter.txt \
 	openvpn.8.rst \
 	openvpn-examples.5.rst \
+	README.man \
+	README.plugins \
+	tls-crypt-v2.txt \
 	$(openvpn_sections) \
 	$(openvpn_examples_sections)
 
+EXTRA_DIST = tests
+
 # dependencies
 openvpn.8 openvpn.8.html: $(openvpn_sections)
 openvpn-examples.5 openvpn-examples.5.html: $(openvpn_examples_sections)
doc/doxygen/Makefile.am +20 -1
index 82d909dd..ec1045eb 100644
@@ -13,8 +13,27 @@ MAINTAINERCLEANFILES = \
 
 DISTCLEANFILES = openvpn.doxyfile
 
+DOXYGEN_EXTRA_FILES = \
+	doc_compression.h \
+	doc_control_processor.h \
+	doc_control_tls.h \
+	doc_data_control.h \
+	doc_data_crypto.h \
+	doc_eventloop.h \
+	doc_external_multiplexer.h \
+	doc_fragmentation.h \
+	doc_internal_multiplexer.h \
+	doc_key_generation.h \
+	doc_mainpage.h \
+	doc_memory_management.h \
+	doc_protocol_overview.h \
+	doc_reliable.h \
+	doc_tunnel_state.h
+
+EXTRA_DIST = $(DOXYGEN_EXTRA_FILES)
+
 .PHONY: doxygen
-doxygen: openvpn.doxyfile
+doxygen: openvpn.doxyfile $(DOXYGEN_EXTRA_FILES)
 	doxygen openvpn.doxyfile
 
 clean-local:
Signature · 1 line
2.34.1
Acked-by on v1 1/4
#5 lore raw
In reply to Frank Lichtenheld

There is not much meat to the patch, except "bundle a few extra files", so this is what I tested. Diffing "make dist" created tarballs with and without this patch confirms "it adds vcpkg.json + git-version.py".

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

commit 6801260dba38ae99f8726c2840ddf6bed57ee1d0 (master) commit af60fdc7d57462ed2509cb5247dc6e394451fa8d (release/2.6)

Author: Frank Lichtenheld
Date:   Mon Jun 19 15:29:31 2023 +0200
     dist: add more missing files only used in the MSVC build

     Signed-off-by: Frank Lichtenheld <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg26748.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering

Acked-by on v1 2/4
#7 lore raw

[Openvpn-devel] [PATCH applied] Re: vcpkg-ports/pkcs11-helper: rename patches to make file names shorter

In reply to Frank Lichtenheld

Indeed, this fixes bundling for the one patch with an extra-long name (so the tar file diffs have 2 file renames, plus one extra file).

To verify whether things still build, I've run via local mingw build (works) and GHA (works).

This does not apply to release/2.6, because the "fix build with disable shared" commit (commit 17746e53f6) is not in 2.6. Do we need it there?

Your patch has been applied to the master branch.

commit 0c25a5462e945f537d1836b47a5f147a2132875c

Author: Frank Lichtenheld
Date:   Mon Jun 19 15:29:32 2023 +0200
     vcpkg-ports/pkcs11-helper: rename patches to make file names shorter

     Signed-off-by: Frank Lichtenheld <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg26747.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering

Acked-by on v1 3/4
#10 lore raw

[Openvpn-devel] [PATCH applied] Re: unit_tests: Add missing cert_data.h to source list for unit tests

In reply to Frank Lichtenheld

"make sense". Verified that it still builds ;-) - and adds this extra file to the tarball.

The patch does not apply to release/2.6, because the whole pkey_test_utils.c part is not part of 2.6.

Your patch has been applied to the master branch.

commit 97223cb057a0edfafd28b34427449bb3eda7d0be

Author: Frank Lichtenheld
Date:   Mon Jun 19 15:29:33 2023 +0200
     unit_tests: Add missing cert_data.h to source list for unit tests

     Signed-off-by: Frank Lichtenheld <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg26750.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering

Acked-by on v1 4/4
#12 lore raw

[Openvpn-devel] [PATCH applied] Re: dist: Include all documentation in distribution

In reply to Frank Lichtenheld

"Makes sense". If we have all these nice files, so well maintained, why not share them.

(We might want to have a look into these doxygen files and see if part of the documentation has become stale over time... I have not seen any updates in a long time, except for copyright year changes)

Your patch has been applied to the master branch.

commit 9ccb14970387d7c13589b85b0ca7048cebf52c6d (master) commit bf5c5dee7cdc189660ad35e9aaecf4aea5aec4cf (release/2.6)

Author: Frank Lichtenheld
Date:   Mon Jun 19 15:29:34 2023 +0200
     dist: Include all documentation in distribution

     Signed-off-by: Frank Lichtenheld <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg26749.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering

#8 lore raw

Re: [Openvpn-devel] [PATCH applied] Re: vcpkg-ports/pkcs11-helper: rename patches to make file names shorter

In reply to Gert Doering
Quoted 10 lines · Gert Doering

Indeed, this fixes bundling for the one patch with an extra-long name (so the tar file diffs have 2 file renames, plus one extra file).

To verify whether things still build, I've run via local mingw build (works) and GHA (works).

This does not apply to release/2.6, because the "fix build with disable shared" commit (commit 17746e53f6) is not in 2.6. Do we need it there?

Not right now. But if we want to merge CMake to release/2.6 we will need to merge the pkcs11 changes as well and then we need this patch as well.

The CMake patches will also not apply cleanly on release/2.6 so we would need to make a separate patch series for that anyway.

Quoted 20 lines

Your patch has been applied to the master branch.

commit 0c25a5462e945f537d1836b47a5f147a2132875c

Author: Frank Lichtenheld
Date:   Mon Jun 19 15:29:32 2023 +0200
     vcpkg-ports/pkcs11-helper: rename patches to make file names shorter

     Signed-off-by: Frank Lichtenheld <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg26747.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering

Signature · 1 line
  Frank Lichtenheld