2021-05-11 18:02:57

by Tedd Ho-Jeong An

[permalink] [raw]
Subject: [BlueZ PATCH] config: Show error if rst2man not found when manpages are enabled

From: Tedd Ho-Jeong An <[email protected]>

This patch adds a check if the conversion tool is installed when the
manpages is enabled, and show error if it is not installed.
---
configure.ac | 3 +++
1 file changed, 3 insertions(+)

diff --git a/configure.ac b/configure.ac
index f445589b0..2b044f8e5 100644
--- a/configure.ac
+++ b/configure.ac
@@ -328,6 +328,9 @@ AC_ARG_ENABLE(manpages, AC_HELP_STRING([--enable-manpages],
[enable_manpages=${enableval}])
if (test "${enable_manpages}" != "no"); then
AC_CHECK_PROGS(RST2MAN, [rst2man rst2man.py], "no")
+ if (test "${RST2MAN}" = "no" ); then
+ AC_MSG_ERROR([rst2man is required])
+ fi
fi
AM_CONDITIONAL(MANPAGES, test "${enable_manpages}" = "yes")
AM_CONDITIONAL(RUN_RST2MAN, test "${enable_manpages}" = "yes" && test "${RST2MAN}" != "no")
--
2.26.3


2021-05-11 18:09:56

by Luiz Augusto von Dentz

[permalink] [raw]
Subject: Re: [BlueZ PATCH] config: Show error if rst2man not found when manpages are enabled

Hi Tedd,

On Tue, May 11, 2021 at 11:02 AM Tedd Ho-Jeong An <[email protected]> wrote:
>
> From: Tedd Ho-Jeong An <[email protected]>
>
> This patch adds a check if the conversion tool is installed when the
> manpages is enabled, and show error if it is not installed.
> ---
> configure.ac | 3 +++
> 1 file changed, 3 insertions(+)
>
> diff --git a/configure.ac b/configure.ac
> index f445589b0..2b044f8e5 100644
> --- a/configure.ac
> +++ b/configure.ac
> @@ -328,6 +328,9 @@ AC_ARG_ENABLE(manpages, AC_HELP_STRING([--enable-manpages],
> [enable_manpages=${enableval}])
> if (test "${enable_manpages}" != "no"); then
> AC_CHECK_PROGS(RST2MAN, [rst2man rst2man.py], "no")
> + if (test "${RST2MAN}" = "no" ); then
> + AC_MSG_ERROR([rst2man is required])

I guess we can mention that it is typically packaged with
python-docutils e.g: rstman is required: install python-docutils or
alternatively we check python-docutils with pkgconfig since it will be
a hard dependency anyway.

> + fi
> fi
> AM_CONDITIONAL(MANPAGES, test "${enable_manpages}" = "yes")
> AM_CONDITIONAL(RUN_RST2MAN, test "${enable_manpages}" = "yes" && test "${RST2MAN}" != "no")
> --
> 2.26.3
>


--
Luiz Augusto von Dentz

2021-05-11 18:25:51

by Tedd Ho-Jeong An

[permalink] [raw]
Subject: Re: [BlueZ PATCH] config: Show error if rst2man not found when manpages are enabled

Hi Luiz,

On Tue, 2021-05-11 at 11:07 -0700, Luiz Augusto von Dentz wrote:
> Hi Tedd,
>
> On Tue, May 11, 2021 at 11:02 AM Tedd Ho-Jeong An <[email protected]> wrote:
> > From: Tedd Ho-Jeong An <[email protected]>
> >
> > This patch adds a check if the conversion tool is installed when the
> > manpages is enabled, and show error if it is not installed.
> > ---
> > configure.ac | 3 +++
> > 1 file changed, 3 insertions(+)
> >
> > diff --git a/configure.ac b/configure.ac
> > index f445589b0..2b044f8e5 100644
> > --- a/configure.ac
> > +++ b/configure.ac
> > @@ -328,6 +328,9 @@ AC_ARG_ENABLE(manpages, AC_HELP_STRING([--enable-manpages],
> > [enable_manpages=${enableval}])
> > if (test "${enable_manpages}" != "no"); then
> > AC_CHECK_PROGS(RST2MAN, [rst2man rst2man.py], "no")
> > + if (test "${RST2MAN}" = "no" ); then
> > + AC_MSG_ERROR([rst2man is required])
>
> I guess we can mention that it is typically packaged with
> python-docutils e.g: rstman is required: install python-docutils or
> alternatively we check python-docutils with pkgconfig since it will be
> a hard dependency anyway.

Just to keep the consistency with other errors in configure.ac, I think it is better to say
like it instead of mentioning the package name.
Also, there is a python3-docutils and python-docutils depending on the python version
that user is using. So it may confuse the user, and the package name may different
for other distros (I didn't check though...).

>
> > + fi
> > fi
> > AM_CONDITIONAL(MANPAGES, test "${enable_manpages}" = "yes")
> > AM_CONDITIONAL(RUN_RST2MAN, test "${enable_manpages}" = "yes" && test "${RST2MAN}" != "no")
> > --
> > 2.26.3
> >
>
>

2021-05-11 18:56:08

by bluez.test.bot

[permalink] [raw]
Subject: RE: [BlueZ] config: Show error if rst2man not found when manpages are enabled

This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list.
This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=480621

---Test result---

Test Summary:
CheckPatch PASS 0.66 seconds
GitLint PASS 0.14 seconds
Prep - Setup ELL PASS 52.43 seconds
Build - Prep PASS 0.16 seconds
Build - Configure PASS 9.31 seconds
Build - Make PASS 220.57 seconds
Make Check PASS 9.17 seconds
Make Dist PASS 13.43 seconds
Make Dist - Configure PASS 5.48 seconds
Make Dist - Make PASS 89.69 seconds
Build w/ext ELL - Configure PASS 9.07 seconds
Build w/ext ELL - Make PASS 212.28 seconds

Details
##############################
Test: CheckPatch - PASS
Desc: Run checkpatch.pl script with rule in .checkpatch.conf

##############################
Test: GitLint - PASS
Desc: Run gitlint with rule in .gitlint

##############################
Test: Prep - Setup ELL - PASS
Desc: Clone, build, and install ELL

##############################
Test: Build - Prep - PASS
Desc: Prepare environment for build

##############################
Test: Build - Configure - PASS
Desc: Configure the BlueZ source tree

##############################
Test: Build - Make - PASS
Desc: Build the BlueZ source tree

##############################
Test: Make Check - PASS
Desc: Run 'make check'

##############################
Test: Make Dist - PASS
Desc: Run 'make dist' and build the distribution tarball

##############################
Test: Make Dist - Configure - PASS
Desc: Configure the source from distribution tarball

##############################
Test: Make Dist - Make - PASS
Desc: Build the source from distribution tarball

##############################
Test: Build w/ext ELL - Configure - PASS
Desc: Configure BlueZ source with '--enable-external-ell' configuration

##############################
Test: Build w/ext ELL - Make - PASS
Desc: Build BlueZ source with '--enable-external-ell' configuration



---
Regards,
Linux Bluetooth