[Spice-devel] [PATCH] Make asciidoc a hard requirement

Frediano Ziglio fziglio at redhat.com
Tue May 3 15:36:24 UTC 2016


> 
> On 05/02/2016 07:39 AM, Uri Lublin wrote:
> > On 04/26/2016 12:23 AM, Eduardo Lima (Etrunko) wrote:
> >> The problem happens when you run 'make dist' in a system without
> >> asciidoc installed. Even though in configure time there is a check for
> >> building the manual, it is required to be built for distribution.
> > 
> > Hi,
> > 
> > I think we should not force building the manual nor require asciidoc
> > to build spice-server.
> > 
> 
> I disagree. The output of make dist should be the same no matter what
> system the command is run. Users should have the required dependencies
> installed if they are interested in building spice-server from the
> source code tarball.
> 

I agree with Eduardo. The make dist should build a tarball containing
everything and be the same.

However users should also have the option to build spice-server, install
it on their system without having to build the documentation.

So asciidoc should be required for "make dist" but not "make all" or
"make install", despite any possible --enable/disable-manual.

Frediano

> > We better find another way to make 'make dist' work
> > 
> > Regards,
> >     Uri.
> > 
> 
> The only other option I see is to keep track of the generated files in
> git, and if there is any modifications, generate it again manually.
> 
> > 
> >>
> >> Signed-off-by: Eduardo Lima (Etrunko) <etrunko at redhat.com>
> >> ---
> >>  configure.ac            | 25 ++++++-------------------
> >>  docs/Makefile.am        |  2 --
> >>  docs/manual/Makefile.am |  8 +-------
> >>  3 files changed, 7 insertions(+), 28 deletions(-)
> >>
> >> diff --git a/configure.ac b/configure.ac
> >> index 8419508..18b907a 100644
> >> --- a/configure.ac
> >> +++ b/configure.ac
> >> @@ -155,24 +155,12 @@ if test "x$enable_automated_tests" = "xyes"; then
> >>  fi
> >>
> >>
> >> -AC_ARG_ENABLE([manual],
> >> -               AS_HELP_STRING([--enable-manual=@<:@auto/yes/no@:>@],
> >> -                              [Build SPICE manual]),
> >> -               [],
> >> -               [enable_manual="auto"])
> >> -if test "x$enable_manual" != "xno"; then
> >> -    AC_PATH_PROG([ASCIIDOC], [asciidoc])
> >> -    AS_IF([test -z "$ASCIIDOC" && test "x$enable_manual" = "xyes"],
> >> -          [AC_MSG_ERROR([asciidoc is missing and build of manual was
> >> requested])])
> >> -    AC_PATH_PROG([A2X], [a2x])
> >> -    AS_IF([test -z "$A2X" && test "x$enable_manual" = "xyes"],
> >> -          [AC_MSG_ERROR([a2x is missing and build of manual was
> >> requested])])
> >> -fi
> >> -AS_IF([test -n "$ASCIIDOC"], [have_asciidoc=yes], [have_asciidoc=no])
> >> -AM_CONDITIONAL([BUILD_MANUAL], [test -n "$ASCIIDOC" || test -n "$A2X"])
> >> -AM_CONDITIONAL([BUILD_HTML_MANUAL], [test -n "$ASCIIDOC"])
> >> -AM_CONDITIONAL([BUILD_CHUNKED_MANUAL], [test -n "$A2X"])
> >> -
> >> +AC_PATH_PROG([ASCIIDOC], [asciidoc])
> >> +AS_IF([test -z "$ASCIIDOC"],
> >> +      [AC_MSG_ERROR([asciidoc is missing])])
> >> +AC_PATH_PROG([A2X], [a2x])
> >> +AS_IF([test -z "$A2X"],
> >> +      [AC_MSG_ERROR([a2x is missing])])
> >>
> >>  dnl
> >> ===========================================================================
> >>
> >>  dnl check compiler flags
> >> @@ -245,7 +233,6 @@ AC_MSG_NOTICE([
> >>          Smartcard:                ${have_smartcard}
> >>          SASL support:             ${have_sasl}
> >>          Automated tests:          ${enable_automated_tests}
> >> -        Manual:                   ${have_asciidoc}
> >>
> >>          Now type 'make' to build $PACKAGE
> >>  ])
> >> diff --git a/docs/Makefile.am b/docs/Makefile.am
> >> index 18e785f..e76efaf 100644
> >> --- a/docs/Makefile.am
> >> +++ b/docs/Makefile.am
> >> @@ -1,3 +1 @@
> >> -if BUILD_MANUAL
> >>  SUBDIRS = manual
> >> -endif
> >> diff --git a/docs/manual/Makefile.am b/docs/manual/Makefile.am
> >> index 24a11fe..beda615 100644
> >> --- a/docs/manual/Makefile.am
> >> +++ b/docs/manual/Makefile.am
> >> @@ -16,13 +16,7 @@ EXTRA_DIST =                    \
> >>  manual.chunked: manual.txt
> >>      $(AM_V_GEN) $(A2X) -f chunked -D $(builddir) $(ASCIIDOC_FLAGS) $<
> >>
> >> -docfiles =
> >> -if BUILD_HTML_MANUAL
> >> -docfiles += manual.html
> >> -endif
> >> -if BUILD_CHUNKED_MANUAL
> >> -docfiles += manual.chunked
> >> -endif
> >> +docfiles = manual.html manual.chunked
> >>
> >>  all-local: $(docfiles)
> >>
> >>
> > 
> 
> 
> --
> Eduardo de Barros Lima (Etrunko)
> Software Engineer - RedHat
> etrunko at redhat.com
> _______________________________________________
> Spice-devel mailing list
> Spice-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/spice-devel
> 


More information about the Spice-devel mailing list