Fix for bug #688 (documentation building)

[Vincent Béron]

This one I'm not sure which one is better. So I include both patches,
but only one should be applied.

Functionnally, both produce the exact same html files, although the fix1
creates (by the system's db2html) a directory with images (which are
unused).

So I'd tend to go with fix2.

Please comment, and I'll post the good one to wine-patches.

Vincent

[Tony Lambregts]

Vincent Béron wrote:
> This one I'm not sure which one is better. So I include both patches,
> but only one should be applied.
>
> Functionnally, both produce the exact same html files, although the fix1
> creates (by the system's db2html) a directory with images (which are
> unused).
>
> So I'd tend to go with fix2.
>
> Please comment, and I'll post the good one to wine-patches.
>
> Vincent
> Index: wine/documentation/Makefile.in
>
> RCS file: /home/wine/wine/documentation/Makefile.in,v
> retrieving revision 1.24
> diff -u -r1.24 Makefile.in
> --- Makefile.in	17 Sep 2002 18:44:46 -0000	1.24
> +++ Makefile.in	9 Nov 2002 00:18:33 -0000
> @@ -65,7 +65,7 @@
> .PHONY: everything doc html pdf ps
>
> $(BOOKNAME)/index.html: $(BOOK_SRCS)
> - $(DB2HTML) $(BOOKNAME).sgml
> - $(DB2HTML) -d ./default.dsl $(BOOKNAME).sgml
>
> $(BOOKNAME).pdf: $(BOOK_SRCS)
>    db2pdf -d ./print.dsl $(BOOKNAME).sgml > /dev/null
> Index: wine/documentation/Makefile.in
>
> RCS file: /home/wine/wine/documentation/Makefile.in,v
> retrieving revision 1.24
> diff -u -r1.24 Makefile.in
> --- Makefile.in	17 Sep 2002 18:44:46 -0000	1.24
> +++ Makefile.in	9 Nov 2002 00:19:34 -0000
> @@ -4,7 +4,7 @@
> VPATH     = @srcdir@
> MODULE    = none
> BOOKNAME  = wine-doc
> -DB2HTML   = db2html
> +DB2HTML   = ./db2html-winehq
>
> EXTRASUBDIRS = samples status

I would go with patch 2 myself. Cleaner is better.

[Sylvain Petreolle]

We should test if the db2xxxx or docbook2xxxx binaries are available so
we could support both...
Otherwise some modifications must be done.
A bad redirection order in command lines is causing missing error
messages.

Without patch attached , the 'db2xxxx : command not found' messages are
redirected to /dev/null and people asking why tar is failing when
adding non generated files.

Comments ?

--- Vincent Béron  a écrit : > This one
I'm not sure which one is better. So I include both patches,
> but only one should be applied.
>
> Functionnally, both produce the exact same html files, although the
> fix1
> creates (by the system's db2html) a directory with images (which are
> unused).
>
> So I'd tend to go with fix2.
>
> Please comment, and I'll post the good one to wine-patches.
>
> Vincent
> > Index: wine/documentation/Makefile.in
>
> ===================================================================
> RCS file: /home/wine/wine/documentation/Makefile.in,v
> retrieving revision 1.24
> diff -u -r1.24 Makefile.in
> --- Makefile.in	17 Sep 2002 18:44:46 -0000	1.24
> +++ Makefile.in	9 Nov 2002 00:18:33 -0000
> @@ -65,7 +65,7 @@
>  .PHONY: everything doc html pdf ps
>
> $(BOOKNAME)/index.html: $(BOOK_SRCS)
> - $(DB2HTML) $(BOOKNAME).sgml
> - $(DB2HTML) -d ./default.dsl $(BOOKNAME).sgml
>
> $(BOOKNAME).pdf: $(BOOK_SRCS)
>    db2pdf -d ./print.dsl $(BOOKNAME).sgml > /dev/null
> > Index: wine/documentation/Makefile.in
>
> ===================================================================
> RCS file: /home/wine/wine/documentation/Makefile.in,v
> retrieving revision 1.24
> diff -u -r1.24 Makefile.in
> --- Makefile.in	17 Sep 2002 18:44:46 -0000	1.24
> +++ Makefile.in	9 Nov 2002 00:19:34 -0000
> @@ -4,7 +4,7 @@
>  VPATH     = @srcdir@
>  MODULE    = none
>  BOOKNAME  = wine-doc
> -DB2HTML   = db2html
> +DB2HTML   = ./db2html-winehq
>
> EXTRASUBDIRS = samples status

___________________________________________________________
Do You Yahoo!? -- Une adresse @yahoo.fr gratuite et en français !
Yahoo! Mail : http://fr.mail.yahoo.com

--- make_winehq	2002-11-09 03:55:16.000000000 +0100
+++ make_winehq.new	2002-11-09 04:05:01.000000000 +0100
@@ -46,25 +46,25 @@

## Create PostScript tarball
 echo "db2ps -d ./print.dsl wine-user.sgml"
-db2ps -d ./print.dsl wine-user.sgml > /dev/null 2>&1
+db2ps -d ./print.dsl wine-user.sgml 2>&1 > /dev/null
 echo "db2ps -d ./print.dsl wine-devel.sgml"
-db2ps -d ./print.dsl wine-devel.sgml > /dev/null 2>&1
+db2ps -d ./print.dsl wine-devel.sgml 2>&1 > /dev/null
 echo "db2ps -d ./print.dsl winelib-user.sgml"
-db2ps -d ./print.dsl winelib-user.sgml > /dev/null 2>&1
+db2ps -d ./print.dsl winelib-user.sgml 2>&1 > /dev/null
 echo "db2ps -d ./print.dsl wine-pkg.sgml"
-db2ps -d ./print.dsl wine-pkg.sgml > /dev/null 2>&1
+db2ps -d ./print.dsl wine-pkg.sgml 2>&1 > /dev/null
 tar czf winedoc-ps.tgz wine-user.ps wine-devel.ps winelib-user.ps wine-pkg.ps
 cp winedoc-ps.tgz "$WWWDIR"

## Create PDF tarball
 echo "db2pdf -d ./print.dsl wine-user.sgml"
-db2pdf -d ./print.dsl wine-user.sgml > /dev/null 2>&1
+db2pdf -d ./print.dsl wine-user.sgml 2>&1 > /dev/null
 echo "db2pdf -d ./print.dsl wine-devel.sgml"
-db2pdf -d ./print.dsl wine-devel.sgml > /dev/null 2>&1
+db2pdf -d ./print.dsl wine-devel.sgml 2>&1 > /dev/null
 echo "db2pdf -d ./print.dsl winelib-user.sgml"
-db2pdf -d ./print.dsl winelib-user.sgml > /dev/null 2>&1
+db2pdf -d ./print.dsl winelib-user.sgml 2>&1 > /dev/null
 echo "db2pdf -d ./print.dsl wine-pkg.sgml"
-db2pdf -d ./print.dsl wine-pkg.sgml > /dev/null 2>&1
+db2pdf -d ./print.dsl wine-pkg.sgml 2>&1 > /dev/null
 tar czf winedoc-pdf.tgz wine-user.pdf wine-devel.pdf winelib-user.pdf wine-pkg.pdf
 cp winedoc-pdf.tgz "$WWWDIR"

[Vincent Béron]

Le ven 08/11/2002 à 23:13, Sylvain Petreolle a écrit :
> We should test if the db2xxxx or docbook2xxxx binaries are available so
> we could support both...

configure is where to do that. You do it? :)
> Otherwise some modifications must be done.
> A bad redirection order in command lines is causing missing error
> messages.
>
> Without patch attached , the 'db2xxxx : command not found' messages are
> redirected to /dev/null and people asking why tar is failing when
> adding non generated files.
>
> Comments ?

The unhiding of error messages is probably a good thing (especially if
people report some problems).

But if we first determine which one is installed (eg db2html or
docbook2html), then what is the best way to handle the absence of any of
those (aka "I can't build the doc")?

Last thing: make_winehq is not meant to build the documentation on a
general basis. make doc is for that, and the html files are now
correctly named with any one of the 2 patches I sent earlier (I think
the second one will get sent to wine-patches). There are some
differences between make_winehq and make doc: the first one buids each
guide separatly, then a big one comprising the four (5 directories in
total), and finally the same thing with another dsl, while make doc only
builds the big one. So we may want to add a make target to build the
different guides separately. But make_winehq is not the right thing to
call if you don't place the result on a website.

Vincent

[Sylvain Petreolle]

--- Vincent Béron  a écrit : > Le ven
08/11/2002 à 23:13, Sylvain Petreolle a écrit :
> > We should test if the db2xxxx or docbook2xxxx binaries are
>
> available so
> > we could support both...
>
> configure is where to do that. You do it? :)

configure.ac and his neighboors are a mystery for me at the moment :)
> The unhiding of error messages is probably a good thing (especially
> if
> people report some problems).
> But if we first determine which one is installed (eg db2html or
> docbook2html), then what is the best way to handle the absence of any
> of
> those (aka "I can't build the doc")?

Fully agreed.
> Last thing: make_winehq is not meant to build the documentation on a
> general basis. make doc is for that, and the html files are now
> correctly named with any one of the 2 patches I sent earlier (I think
> the second one will get sent to wine-patches). There are some
> differences between make_winehq and make doc: the first one buids
> each guide separatly, then a big one comprising the four (5
> directories in total), and finally the same thing with another dsl,
> while make doc only builds the big one. So we may want to add a make
> target to build the different guides separately. But make_winehq is
> not the right thing to call if you don't place the result on a

website.

Agreed.

I must add one thing : make clean doesn't work for now. It removes
*.tgz and others but the directories containing the old doc aren't
removed.

Neither does 'make doc'. wine-doc is moved to wine-doc.junk by jade and
that's all.

Or does it works with your patch ? Didn't have time to test it.

___________________________________________________________
Do You Yahoo!? -- Une adresse @yahoo.fr gratuite et en français !
Yahoo! Mail : http://fr.mail.yahoo.com

[Dustin Navea]

why create code bloat?  make it &> /dev/null and remove the > /dev/null and
the 2>&1 ...  &> /dev/null covers both quite nicely

-Dustin
--- Sylvain Petreolle  wrote:
> We should test if the db2xxxx or docbook2xxxx binaries are available so
> we could support both...
> Otherwise some modifications must be done.
> A bad redirection order in command lines is causing missing error
> messages.
>
> Without patch attached , the 'db2xxxx : command not found' messages are
> redirected to /dev/null and people asking why tar is failing when
> adding non generated files.
>
> Comments ?
>
> --- Vincent B�ron  a �crit�: > This one
> I'm not sure which one is better. So I include both patches,
> > but only one should be applied.
> >
> > Functionnally, both produce the exact same html files, although the
> > fix1
> > creates (by the system's db2html) a directory with images (which are
> > unused).
> >
> > So I'd tend to go with fix2.
> >
> > Please comment, and I'll post the good one to wine-patches.
> >
> > Vincent
> > > Index: wine/documentation/Makefile.in
> >
> > ===================================================================
> > RCS file: /home/wine/wine/documentation/Makefile.in,v
> > retrieving revision 1.24
> > diff -u -r1.24 Makefile.in
> > --- Makefile.in	17 Sep 2002 18:44:46 -0000	1.24
> > +++ Makefile.in	9 Nov 2002 00:18:33 -0000
> > @@ -65,7 +65,7 @@
> >  .PHONY: everything doc html pdf ps
> >
> > $(BOOKNAME)/index.html: $(BOOK_SRCS)
> > - $(DB2HTML) $(BOOKNAME).sgml
> > - $(DB2HTML) -d ./default.dsl $(BOOKNAME).sgml
> >
> > $(BOOKNAME).pdf: $(BOOK_SRCS)
> >    db2pdf -d ./print.dsl $(BOOKNAME).sgml > /dev/null
> > > Index: wine/documentation/Makefile.in
> >
> > ===================================================================
> > RCS file: /home/wine/wine/documentation/Makefile.in,v
> > retrieving revision 1.24
> > diff -u -r1.24 Makefile.in
> > --- Makefile.in	17 Sep 2002 18:44:46 -0000	1.24
> > +++ Makefile.in	9 Nov 2002 00:19:34 -0000
> > @@ -4,7 +4,7 @@
> >  VPATH     = @srcdir@
> >  MODULE    = none
> >  BOOKNAME  = wine-doc
> > -DB2HTML   = db2html
> > +DB2HTML   = ./db2html-winehq
> >
> > EXTRASUBDIRS = samples status
>
> Do You Yahoo!? -- Une adresse @yahoo.fr gratuite et en fran�ais !
> Yahoo! Mail : http://fr.mail.yahoo.com%3E --- make_winehq	2002-11-09

03:55:16.000000000 +0100
> +++ make_winehq.new	2002-11-09 04:05:01.000000000 +0100
> @@ -46,25 +46,25 @@
>
> ## Create PostScript tarball
>  echo "db2ps -d ./print.dsl wine-user.sgml"
> -db2ps -d ./print.dsl wine-user.sgml > /dev/null 2>&1
> +db2ps -d ./print.dsl wine-user.sgml 2>&1 > /dev/null
>  echo "db2ps -d ./print.dsl wine-devel.sgml"
> -db2ps -d ./print.dsl wine-devel.sgml > /dev/null 2>&1
> +db2ps -d ./print.dsl wine-devel.sgml 2>&1 > /dev/null
>  echo "db2ps -d ./print.dsl winelib-user.sgml"
> -db2ps -d ./print.dsl winelib-user.sgml > /dev/null 2>&1
> +db2ps -d ./print.dsl winelib-user.sgml 2>&1 > /dev/null
>  echo "db2ps -d ./print.dsl wine-pkg.sgml"
> -db2ps -d ./print.dsl wine-pkg.sgml > /dev/null 2>&1
> +db2ps -d ./print.dsl wine-pkg.sgml 2>&1 > /dev/null
>  tar czf winedoc-ps.tgz wine-user.ps wine-devel.ps winelib-user.ps
> wine-pkg.ps
>  cp winedoc-ps.tgz "$WWWDIR"
>
> ## Create PDF tarball
>  echo "db2pdf -d ./print.dsl wine-user.sgml"
> -db2pdf -d ./print.dsl wine-user.sgml > /dev/null 2>&1
> +db2pdf -d ./print.dsl wine-user.sgml 2>&1 > /dev/null
>  echo "db2pdf -d ./print.dsl wine-devel.sgml"
> -db2pdf -d ./print.dsl wine-devel.sgml > /dev/null 2>&1
> +db2pdf -d ./print.dsl wine-devel.sgml 2>&1 > /dev/null
>  echo "db2pdf -d ./print.dsl winelib-user.sgml"
> -db2pdf -d ./print.dsl winelib-user.sgml > /dev/null 2>&1
> +db2pdf -d ./print.dsl winelib-user.sgml 2>&1 > /dev/null
>  echo "db2pdf -d ./print.dsl wine-pkg.sgml"
> -db2pdf -d ./print.dsl wine-pkg.sgml > /dev/null 2>&1
> +db2pdf -d ./print.dsl wine-pkg.sgml 2>&1 > /dev/null
>  tar czf winedoc-pdf.tgz wine-user.pdf wine-devel.pdf winelib-user.pdf
> wine-pkg.pdf
>  cp winedoc-pdf.tgz "$WWWDIR"

__________________________________________________
Do you Yahoo!?
U2 on LAUNCH - Exclusive greatest hits videos
http://launch.yahoo.com/u2

[Vincent Béron]

Le sam 09/11/2002 à 22:44, Dustin Navea a écrit :
> why create code bloat?  make it &> /dev/null and remove the > /dev/null and
> the 2>&1 ...  &> /dev/null covers both quite nicely

If you do that, you hide the error message the shell spits out if it
cannot find the command, which was the reason Sylvain proposed the
change.

Vincent