Re: [AD] pdf and bzipped documentation |
[ Thread Index |
Date Index
| More lists.liballeg.org/allegro-developers Archives
]
> - Adds and documents the makefile target docs-pdf under Unix. This
> uses texi2pdf to generate a pdf file (useful compared to postscript
> because it has hyperlinks).
Nice! Some minor nits:
@@ -230,16 +230,25 @@
docs-dvi: $(srcdir)/docs/allegro.dvi
@echo "Device independant documentation generated: docs/allegro.dvi"
- @echo "Run make docs-ps if you wish to generate postscript documentation
(you need dvips)"
+ @echo "Run make docs-ps to generate postscript documentation (you need
dvips),"
+ @echo "or make docs-pdf for pdf (you need dvipdf)."
Postscript, PDF. And dvipf or texi2pdf?
@@ -287,6 +296,9 @@
docs/allegro.ps: docs/allegro.dvi
cd docs && dvips -o allegro.ps allegro.dvi && cd ..
+docs/allegro.pdf: docs/allegro.dvi
+ cd docs && texi2pdf --texinfo='@topandbottommargin=.75in' texi/allegro.texi
&& cd ..
Wrong dependency.
@@ -400,7 +412,7 @@
@echo "Run make install-man if you wish to install the man pages"
@echo "Run make install-info if you wish to install the info documentation"
@echo "You may conserve space by instead running make install-gzipped-man"
- @echo "and/or make install-gzipped-info"
+ @echo "and/or make install-gzipped-info. Or install-bzipped-... to use
bzip2."
I don't like the "..." very much. Please be explicit here.
@@ -615,10 +645,12 @@
@echo "Dependency generation completed!"
.PHONY: default full-build lib programs docs docs-dvi docs-ps
docs-gzipped-ps \
+docs-bzipped-ps docs-pdf \
"docs-pdf" should go after "docs-ps"
+ 'docs-pdf' (Unix only)<br>
+ Creates a pdf file. This is not a default target, since you need the
+ texi2pdf tool to create it. The generated file is especially prepared to
+ be printed on paper, and it also has hyperlinks.
PDF.
>
> - Adds and documents the three makefile targets docs-bzipped-ps,
> install-bzipped-man, install-bzipped-info under Unix. These are like the
> *gzip* targets, except uses bzip2 to do the compression (the viewers
> understand this as well). Also clarifies in the documentation that these
> don't work under MacOS X.
Well spotted. Split the entry though, into one with (Unix and MacOS X only)
and one with (Unix only).
<li>
- 'install-info' or 'install-gzipped-info' (Unix only)<br>
+ 'install-info' or 'install-gzipped-info' or 'install-bzipped-info'
+ (Unix only)<br>
Converts the documentation to Info format and installs it. The second
- target compresses the info file after installing it.
+ and third targets only work under Unix, and compress the info file after
+ installing it (run only one of them).
Problem here: does it work under MacOS X? If so, split too. Otherwise, remove
the redundancy.
> - Adds documentation for uninstall-info and uninstall-man to the
> 'makefile targets' section of allegro._tx. Although install-man exists
> for MaxOS X, I couldn't find uninstall-man in makefile.osx. Hence I made
> the docs say 'Unix only' for uninstall-man.
Fine.
--
Eric Botcazou