From 35c8281ef20de507dc08637bff02ce7895b48ec6 Mon Sep 17 00:00:00 2001 From: Lev Stipakov Date: Wed, 25 Aug 2021 19:47:52 +0300 Subject: [PATCH] Add building man page on Windows MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Use rst2html to build html from rst. Ignore errors, this is not fatal and affects only MSI build. Modify MSVC GitHub Actions to install python3/rst2html and add html man page to artifacts. Signed-off-by: Lev Stipakov Acked-by: Samuli Seppänen Message-Id: <20210825164752.808-1-lstipakov@gmail.com> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg22771.html Signed-off-by: Gert Doering (cherry picked from commit d814581a9375713a0a4d70f751f84e750a5d661a) --- .github/workflows/build.yaml | 9 +++++++++ build/msvc/msvc-generate/Makefile.mak | 9 ++++++++- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 5d7dd37b1..4cb2f4ccd 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -206,6 +206,14 @@ jobs: - name: Add MSBuild to PATH uses: microsoft/setup-msbuild@v1 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.x' + + - name: Install rst2html + run: python -m pip install --upgrade pip rst2html + - name: Restore artifacts, or run vcpkg, build and cache artifacts uses: lukka/run-vcpkg@main with: @@ -227,3 +235,4 @@ jobs: path: | ${{ matrix.plat }}-Output/${{env.BUILD_CONFIGURATION}}/*.exe ${{ matrix.plat }}-Output/${{env.BUILD_CONFIGURATION}}/*.dll + doc/openvpn.8.html diff --git a/build/msvc/msvc-generate/Makefile.mak b/build/msvc/msvc-generate/Makefile.mak index 59fc9f0ed..6da859e32 100644 --- a/build/msvc/msvc-generate/Makefile.mak +++ b/build/msvc/msvc-generate/Makefile.mak @@ -11,7 +11,10 @@ OUTPUT_PLUGIN=$(SOURCEBASE)/include/openvpn-plugin.h INPUT_PLUGIN_CONFIG=version.m4.in OUTPUT_PLUGIN_CONFIG=version.m4 -all: $(OUTPUT_MSVC_VER) $(OUTPUT_PLUGIN) +INPUT_MAN=$(SOURCEBASE)/doc/openvpn.8.rst +OUTPUT_MAN=$(SOURCEBASE)/doc/openvpn.8.html + +all: $(OUTPUT_MSVC_VER) $(OUTPUT_PLUGIN) $(OUTPUT_MAN) $(OUTPUT_MSVC_VER): $(INPUT_MSVC_VER) $(CONFIG) cscript //nologo msvc-generate.js --config="$(CONFIG)" --input="$(INPUT_MSVC_VER)" --output="$(OUTPUT_MSVC_VER)" @@ -22,7 +25,11 @@ $(OUTPUT_PLUGIN_CONFIG): $(INPUT_PLUGIN_CONFIG) $(OUTPUT_PLUGIN): $(INPUT_PLUGIN) $(OUTPUT_PLUGIN_CONFIG) cscript //nologo msvc-generate.js --config="$(OUTPUT_PLUGIN_CONFIG)" --input="$(INPUT_PLUGIN)" --output="$(OUTPUT_PLUGIN)" +$(OUTPUT_MAN): $(INPUT_MAN) + -FOR /F %i IN ('where rst2html.py') DO python %i "$(INPUT_MAN)" "$(OUTPUT_MAN)" + clean: -del "$(OUTPUT_MSVC_VER)" -del "$(OUTPUT_PLUGIN)" -del "$(OUTPUT_PLUGIN_CONFIG)" + -del "$(OUTPUT_MAN)" -- 2.47.2