From: Ethan M. <merritt@u.washington.edu> - 2006-07-18 22:44:31
|
On Tuesday 18 July 2006 01:48 am, Bastian Maerkisch wrote: > before I forget about it (again ;): right now the environment > variable GNUPLOT_PS_DIR is not yet documented in gnuplot.doc. I have added this to post.trm, but I notice a problem. I made the documentation conditional on GNUPLOT_PS_DIR being defined at compile-time. Otherwise we'd be documenting a feature that wasn't compiled in. This works fine for generating gnuplot.gih. However, to build the *.tex, *.html, *.pdf documentation we pass the source through the C preprocessor again to build the conversion programs doc2tex and so on. The Makefile in the .../docs directory does not know about conditional compilation flags, so the #ifdef GNUPLOT_PS_DIR parts of the documentation are lost. What is the proper fix? Should Makefile.in contain lines like those in .../src/Makefile.am GNUPLOT_PS_DIR=$(pkgdatadir)/$(VERSION_MAJOR)/PostScript AM_CPPFLAGS = -DGNUPLOT_PS_DIR=\"$(GNUPLOT_PS_DIR)\" (except I suppose it would be CPPFLAGS because it isn't coming from a Makefile.am - when does one need the extra step am->in ??) -- Ethan A Merritt Biomolecular Structure Center University of Washington, Seattle WA |
From: <tim...@en...> - 2006-07-18 23:14:15
Attachments:
gnuplotpsdir.diff
|
Ethan Merritt wrote: > On Tuesday 18 July 2006 01:48 am, Bastian Maerkisch wrote: > =20 >> before I forget about it (again ;): right now the environment >> variable GNUPLOT_PS_DIR is not yet documented in gnuplot.doc. >> =20 > > I have added this to post.trm, but I notice a problem. > I made the documentation conditional on GNUPLOT_PS_DIR being > defined at compile-time. Otherwise we'd be documenting a feature > that wasn't compiled in. This works fine for generating gnuplot.gih. > > However, to build the *.tex, *.html, *.pdf documentation we > pass the source through the C preprocessor again to build the > conversion programs doc2tex and so on. The Makefile in the .../docs > directory does not know about conditional compilation flags, so the > #ifdef GNUPLOT_PS_DIR > parts of the documentation are lost. > > What is the proper fix? > Should Makefile.in contain lines like those in .../src/Makefile.am > > GNUPLOT_PS_DIR=3D$(pkgdatadir)/$(VERSION_MAJOR)/PostScript > AM_CPPFLAGS =3D -DGNUPLOT_PS_DIR=3D\"$(GNUPLOT_PS_DIR)\" > > (except I suppose it would be CPPFLAGS because it isn't coming > from a Makefile.am -=20 The attached patch does the trick (for the 'make pdf' target at least, I=20 have not tested the others). > when does one need the extra step am->in ??) > =20 Here it's a step Makefile.in->Makefile, because automake is not used,=20 but the output of the configure script is. Timoth=E9e |
From: Ethan M. <merritt@u.washington.edu> - 2006-07-18 23:21:18
|
On Tuesday 18 July 2006 06:14 pm, Timoth=C3=A9e Lecomte wrote: > > The Makefile in the > > .../docs directory does not know about conditional compilation > > flags, so the #ifdef GNUPLOT_PS_DIR > > parts of the documentation are lost. > > > > What is the proper fix? > > Should Makefile.in contain lines like those in .../src/Makefile.am > > The attached patch does the trick (for the 'make pdf' target at > least, I have not tested the others). OK, thanks. Do we have to worry about this breaking if someone deliberately wants to compile without GNUPLOT_PS_DIR? =2D-=20 Ethan A Merritt Biomolecular Structure Center University of Washington, Seattle WA |
From: <tim...@en...> - 2006-07-18 23:36:10
|
Ethan Merritt wrote: > On Tuesday 18 July 2006 06:14 pm, Timoth=C3=A9e Lecomte wrote: > =20 >>> The Makefile in the >>> .../docs directory does not know about conditional compilation >>> flags, so the #ifdef GNUPLOT_PS_DIR >>> parts of the documentation are lost. >>> >>> What is the proper fix? >>> Should Makefile.in contain lines like those in .../src/Makefile.am >>> =20 >> The attached patch does the trick (for the 'make pdf' target at >> least, I have not tested the others). >> =20 > > OK, thanks. > > Do we have to worry about this breaking if someone deliberately wants > to compile without GNUPLOT_PS_DIR? > =20 How could someone do that ? If it's by using a custom makefile instead=20 of the ./configure... procedure, then he won't use docs/Makefile.in anywa= y. Timoth=C3=A9e |
From: Petr M. <mi...@ph...> - 2006-07-19 05:05:28
|
> I have added this to post.trm, but I notice a problem. > I made the documentation conditional on GNUPLOT_PS_DIR being > defined at compile-time. Otherwise we'd be documenting a feature > that wasn't compiled in. This works fine for generating gnuplot.gih. > > However, to build the *.tex, *.html, *.pdf documentation we > pass the source through the C preprocessor again to build the > conversion programs doc2tex and so on. The Makefile in the .../docs > directory does not know about conditional compilation flags, so the > #ifdef GNUPLOT_PS_DIR > parts of the documentation are lost. > > What is the proper fix? It is only gnuplot.gih which can contain docs for only the compiled-in features. On the other hand, gnuplot.pdf, gnuplot.dvi, gnuplot.html, ... is the complete gnuplot documentation and it must contains all docs! (Notice that it contains also all terminals.) Thus, there must be both sections of what is happening with and without GNUPLOT_PS_DIR. Please make sure this is realized. --- PM |
From: Ethan A M. <merritt@u.washington.edu> - 2006-07-19 05:32:44
|
On Tuesday 18 July 2006 10:05 pm, Petr Mikulik wrote: > > However, to build the *.tex, *.html, *.pdf documentation we > > pass the source through the C preprocessor again to build the > > conversion programs doc2tex and so on. The Makefile in the .../docs > > directory does not know about conditional compilation flags, so the > > #ifdef GNUPLOT_PS_DIR > > parts of the documentation are lost. > > On the other hand, gnuplot.pdf, gnuplot.dvi, gnuplot.html, ... is the > complete gnuplot documentation and it must contains all docs! (Notice that > it contains also all terminals.) Good point. But that means I must add to the documentation, explaining that some people will have only built-in prolog text while other people have the full set of external files. -- Ethan A Merritt Biomolecular Structure Center University of Washington, Seattle 98195-7742 |
From: <br...@ph...> - 2006-07-20 20:58:58
|
Petr Mikulik wrote: > It is only gnuplot.gih which can contain docs for only the compiled-in > features. Not quite. Same goes for the Windows and OS/2 help files (gnuplot.rtf --> wgnuplot.hlp, gnuplot.ipf --> gnuplot.???) |