References: <20200716225338.611-3-davids@...515...> <202007170802.06H82n5d006538@...2054...> From: David Sommerseth Message-ID: <44e29beb-a441-97c0-bf66-1e2071e1296f@...2080...> Date: Fri, 17 Jul 2020 12:04:30 +0200 MIME-Version: 1.0 In-Reply-To: <202007170802.06H82n5d006538@...2054...> Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="agkaWE6qqzmgYOqLfftF9ZDS1f6TYuvt7" Subject: Re: [Openvpn-devel] [PATCH applied] Re: doc/man: Replace old man page with generated man page List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Gert Doering Cc: openvpn-devel@lists.sourceforge.net This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --agkaWE6qqzmgYOqLfftF9ZDS1f6TYuvt7 Content-Type: multipart/mixed; boundary="TKTCRoEBWEJNQsWla70m8iBgQID4vHLk2"; protected-headers="v1" From: David Sommerseth To: Gert Doering Cc: openvpn-devel@lists.sourceforge.net Message-ID: <44e29beb-a441-97c0-bf66-1e2071e1296f@...2080...> Subject: Re: [PATCH applied] Re: doc/man: Replace old man page with generated man page References: <20200716225338.611-3-davids@...515...> <202007170802.06H82n5d006538@...2054...> In-Reply-To: <202007170802.06H82n5d006538@...2054...> --TKTCRoEBWEJNQsWla70m8iBgQID4vHLk2 Content-Language: en-US Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable On 17/07/2020 10:02, Gert Doering wrote: > Acked-by: Gert Doering >=20 > I have not tested the actual docutils / openvpn.8 generation (Samuli will= =20 > complain loudly if tarball making doesn't work anymore, so that *will*=20 > see testing). Generally it looks sane. >=20 > This condition looks a bit fishy, though... >=20 > +AM_CONDITIONAL([HAVE_PYDOCUTILS], [test "${RST2MAN}" -a "${RST2HTML}"]) >=20 > not sure what that will do in a POSIX shell. Hmm ... whoops. That should probably have been test -n "${RST2MAN}" -a -n "${RST2HTML}" Not sure how that passed during my own tests. I tested it on a various of boxes, but I only have Linux distros easily available. > Maybe this shouldn't be conditional either >=20 > +if HAVE_PYDOCUTILS > dist_noinst_DATA +=3D openvpn.8 >=20 > because it will lead to "tarballs randomly contain openvpn.8 or not,=20 > depending on whether docutils are around" - "make dist" should behave > consistently, and if there are no docutils, I think it should fail, not > silently leave out files. The intention is that the tarball contains prebuilt openvpn.8 and openvpn.h= tml files, which is generated by "make {dist,distcheck}". If these files exist= s, they will not be rebuilt unless explicitly removed. So most users building from the source tarball should not notice any difference from prioer OpenVPN releases. This is what the additional dist-hook rule in doc/Makefile.am do= es; this is run right before the copied source tree is put into a tarball. The challenge is that it must be a conditional to actually pass ./configure= - even when built from source tarballs. Otherwise python-docutils will be a build dependency. We discussed this at the Trento Hackathon and you where skeptic to require a Python stack to be installed to build OpenVPN (as that stack is not a common system dependency in the non-Linux world). So we agr= eed we will ship pre-built man/html files in the source tarballs. However, to do the "make {dist,distcheck}" from the *git repo*, python-docutils need to be a mandatory dependency - because we don't check = in the prebuilt openvpn.8 and openvpn.html files into the git repo. This logic could probably contains some flaws and can be further improved, = but I figured we need to get this tested on a broader set of use cases and OS/distros to better see which annoyances which hits us. --=20 kind regards, David Sommerseth OpenVPN Inc --TKTCRoEBWEJNQsWla70m8iBgQID4vHLk2-- --agkaWE6qqzmgYOqLfftF9ZDS1f6TYuvt7 Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.22 (GNU/Linux) iQIcBAEBCgAGBQJfEXezAAoJEIbPlEyWcf3yUPkP/0I70hLH5pqAYeZOAocYnmDU 8/A2eZUxXqKU6m3xFEXi2gy65i+jsgONxaDm0jfmr8TFmzsdeHA4adqb2T0aY3XD UZ8R3wHYpmBxZJfOiTho46qZF0Zvi9Ic09zSMDZcOJP2f+RPm2Rdbc/J1wpOJHuL +RclZkmeQ5b44kYo/GPnKP8JbFgx/o9Ekxg1E3yH4ocRyCo7QQ+P1v1TozWSGv/R KVwG8JlYnQDVTBZ9wMswn3NgiDMbEniBVkpBmYnjCJnvT2z9ZFsN8ulT1/BJNKod 75vehmjVxqbBvhF8s+gSsl9AyU8275FYHJPW8ucel8NNFyZVRrqmea6jNt476v64 U+DABrPEtQxff5SfBWsDi6s13PMOUo52hY6YNHYt0EWv7yFQRWPTjGK/HvxB6D8o GjBjx7w4yxHIpboMEghQgBdnQgvNJE/+HzcL+i+7yBVRRqCiCOnNZb8k/zsAyto2 C21/v6yRNb2eNY9E1EXnuv+SKU2sDIDGjeyDeK19dFfhb60lTNP2i0KRSn8gDn4o E1Oy0P9KM9uXZYj+bG8Z1Vnoy1vmamvKO3cAH6bzT8IDUWUlbCLqqfTQtBqazDdb 59B6svNsFw2JwPgXkXad8c9fUSoUB/o7yTr3Stapf5fOen9ZZ6WQ5kl1CTUgdy3n da3f0h/OzwLXgACS3y3c =CPJ3 -----END PGP SIGNATURE----- --agkaWE6qqzmgYOqLfftF9ZDS1f6TYuvt7--