diff mbox series

[BlueZ] config: Show error if rst2man not found when manpages are enabled

Message ID 20210511175803.1609438-1-hj.tedd.an@gmail.com
State Superseded
Headers show
Series [BlueZ] config: Show error if rst2man not found when manpages are enabled | expand

Commit Message

Tedd Ho-Jeong An May 11, 2021, 5:58 p.m. UTC
From: Tedd Ho-Jeong An <tedd.an@intel.com>

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(+)

Comments

Tedd Ho-Jeong An May 11, 2021, 6:24 p.m. UTC | #1
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 <hj.tedd.an@gmail.com> wrote:
> > From: Tedd Ho-Jeong An <tedd.an@intel.com>
> > 
> > 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
> > 
> 
>
diff mbox series

Patch

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")