{"thread":{"id":"16675","subject":"[RFC/PATCH] Add support for a pdf version of the user manual","startedAt":"2008-12-10T22:44:50Z","lastAt":"2008-12-11T00:37:40Z","messageCount":6,"participants":["Miklos Vajna","Leo Razoumov","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"97533","messageId":"1228949090-22475-1-git-send-email-vmiklos@frugalware.org","threadId":"16675","inReplyTo":null,"subject":"[RFC/PATCH] Add support for a pdf version of the user manual","fromName":"Miklos Vajna","fromEmail":"vmiklos@frugalware.org","sentAt":"2008-12-10T22:44:50Z","receivedAt":"2008-12-10T22:44:50Z","isPatch":true,"sender":{"key":"vmiklos@frugalware.org","avatar":"https://gravatar.com/avatar/401c1cbbb3a5d13e650c691a2c71d6fd0b80df1a01bc74d9f1972675dd58f2bd?d=mp&s=160"},"body":"Use dblatex in order to create a pdf version of the git user manual. No\nexisting Makefile targets (including \"all\") are touched, so you need to\nexplicitly say\n\nmake pdf\nsudo make install-pdf\n\nto get user-manual.pdf created and installed.\n\nSigned-off-by: Miklos Vajna \n---\n\nHi,\n\nIt turns out that people prefer reading long documents (such as the User\nManual) in a pdf reader, rather then in a web browser. This patch makes\nthem happy.\n\nI marked it RFC as I'm not sure if using the asciidoc dblatex sty and\nxsl file is a good idea or not.\n\n(Oh and because we are in the rc period and this is not a bugfix.)\n\nThe other (info/man/html) formats do not make use of the config files in\n/etc/asciidoc, so maybe it would be better to just copy them in the\nDocumentation dir. OTOH I did not want to cause a duplication without a\ngood reason.\n\nOpinions?\n\nThanks.\n\n Documentation/Makefile | 13 +++++++++++++\n INSTALL | 3 +++\n Makefile | 6 ++++++\n 3 files changed, 22 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex c34c1ca..69f4ade 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -32,6 +32,7 @@ DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))\n prefix?=$(HOME)\n bindir?=$(prefix)/bin\n htmldir?=$(prefix)/share/doc/git-doc\n+pdfdir?=$(prefix)/share/doc/git-doc\n mandir?=$(prefix)/share/man\n man1dir=$(mandir)/man1\n man5dir=$(mandir)/man5\n@@ -50,6 +51,7 @@ infodir?=$(prefix)/share/info\n MAKEINFO=makeinfo\n INSTALL_INFO=install-info\n DOCBOOK2X_TEXI=docbook2x-texi\n+DBLATEX=dblatex\n ifndef PERL_PATH\n \tPERL_PATH = /usr/bin/perl\n endif\n@@ -87,6 +89,8 @@ man7: $(DOC_MAN7)\n \n info: git.info gitman.info\n \n+pdf: user-manual.pdf\n+\n install: install-man\n \n install-man: man\n@@ -107,6 +111,10 @@ install-info: info\n \t echo \"No directory found in $(DESTDIR)$(infodir)\" >&2 ; \\\n \tfi\n \n+install-pdf: pdf\n+\t$(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)\n+\t$(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)\n+\n install-html: html\n \tsh ./install-webdoc.sh $(DESTDIR)$(htmldir)\n \n@@ -190,6 +198,11 @@ user-manual.texi: user-manual.xml\n \t$(DOCBOOK2X_TEXI) user-manual.xml --to-stdout | $(PERL_PATH) fix-texi.perl >$@+\n \tmv $@+ $@\n \n+user-manual.pdf: user-manual.xml\n+\t$(RM) $@+ $@\n+\t$(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $<\n+\tmv $@+ $@\n+\n gitman.texi: $(MAN_XML) cat-texi.perl\n \t$(RM) $@+ $@\n \t($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --to-stdout $(xml);)) | \\\ndiff --git a/INSTALL b/INSTALL\nindex d1deb0b..ae7f750 100644\n--- a/INSTALL\n+++ b/INSTALL\n@@ -101,6 +101,9 @@ Issues of note:\n Building and installing the info file additionally requires\n makeinfo and docbook2X. Version 0.8.3 is known to work.\n \n+ Building and installing the pdf file additionally requires\n+ dblatex. Version 0.2.7 with asciidoc >= 8.2.7 is known to work.\n+\n The documentation is written for AsciiDoc 7, but \"make\n ASCIIDOC8=YesPlease doc\" will let you format with AsciiDoc 8.\n \ndiff --git a/Makefile b/Makefile\nindex 5158197..b1456a2 100644\n--- a/Makefile\n+++ b/Makefile\n@@ -1306,6 +1306,9 @@ html:\n info:\n \t$(MAKE) -C Documentation info\n \n+pdf:\n+\t$(MAKE) -C Documentation pdf\n+\n TAGS:\n \t$(RM) TAGS\n \t$(FIND) . -name '*.[hcS]' -print | xargs etags -a\n@@ -1448,6 +1451,9 @@ install-html:\n install-info:\n \t$(MAKE) -C Documentation install-info\n \n+install-pdf:\n+\t$(MAKE) -C Documentation install-pdf\n+\n quick-install-doc:\n \t$(MAKE) -C Documentation quick-install\n \n-- \n1.6.1.rc1.35.gae26e.dirty\n"},{"id":"97547","messageId":"ee2a733e0812101606m1c522541j9380b6f5d5dc7fc8@mail.gmail.com","threadId":"16675","inReplyTo":"1228949090-22475-1-git-send-email-vmiklos@frugalware.org","subject":"Re: [RFC/PATCH] Add support for a pdf version of the user manual","fromName":"Leo Razoumov","fromEmail":"slonik.az@gmail.com","sentAt":"2008-12-11T00:06:04Z","receivedAt":"2008-12-11T00:06:04Z","isPatch":true,"sender":{"key":"slonik.az@gmail.com","avatar":null},"body":"On 12/10/08, Miklos Vajna wrote:\n> Use dblatex in order to create a pdf version of the git user manual. No\n> existing Makefile targets (including \"all\") are touched, so you need to\n> explicitly say\n>\n> make pdf\n> sudo make install-pdf\n>\n> to get user-manual.pdf created and installed.\n>\n\nThanks a lot! Having manual in pdf forms rocks!\nBTW, for those of us without dblatex, is it possible to have pdf\nmanual pregenerated the same way html and man pages are pregenerated\nfor official releases in the git repo?? I would love to have pdf (and\n'info' for that matter) branch in addition to html and man branches.\n\n--Leo--\n"},{"id":"97548","messageId":"7vd4fzy3il.fsf@gitster.siamese.dyndns.org","threadId":"16675","inReplyTo":"ee2a733e0812101606m1c522541j9380b6f5d5dc7fc8@mail.gmail.com","subject":"Re: [RFC/PATCH] Add support for a pdf version of the user manual","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-12-11T00:11:30Z","receivedAt":"2008-12-11T00:11:30Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Leo Razoumov\" writes:\n\n> BTW, for those of us without dblatex, is it possible to have pdf\n> manual pregenerated the same way html and man pages are pregenerated\n> for official releases in the git repo?\n\nThose of us includes myself, so...\n"},{"id":"97550","messageId":"ee2a733e0812101620s5fc2ff27p81826a5ff827e154@mail.gmail.com","threadId":"16675","inReplyTo":"7vd4fzy3il.fsf@gitster.siamese.dyndns.org","subject":"Re: [RFC/PATCH] Add support for a pdf version of the user manual","fromName":"Leo Razoumov","fromEmail":"slonik.az@gmail.com","sentAt":"2008-12-11T00:20:42Z","receivedAt":"2008-12-11T00:20:42Z","isPatch":true,"sender":{"key":"slonik.az@gmail.com","avatar":null},"body":"On 12/10/08, Junio C Hamano wrote:\n> \"Leo Razoumov\" writes:\n>\n> > BTW, for those of us without dblatex, is it possible to have pdf\n> > manual pregenerated the same way html and man pages are pregenerated\n> > for official releases in the git repo?\n>\n>\n> Those of us includes myself, so...\n\nOuch:-) Does it mean that such a useful patch has a low probability of\nbeing accepted?\n"},{"id":"97555","messageId":"20081211003557.GS5691@genesis.frugalware.org","threadId":"16675","inReplyTo":"ee2a733e0812101620s5fc2ff27p81826a5ff827e154@mail.gmail.com","subject":"Re: [RFC/PATCH] Add support for a pdf version of the user manual","fromName":"Miklos Vajna","fromEmail":"vmiklos@frugalware.org","sentAt":"2008-12-11T00:35:57Z","receivedAt":"2008-12-11T00:35:57Z","isPatch":true,"sender":{"key":"vmiklos@frugalware.org","avatar":"https://gravatar.com/avatar/401c1cbbb3a5d13e650c691a2c71d6fd0b80df1a01bc74d9f1972675dd58f2bd?d=mp&s=160"},"body":"On Wed, Dec 10, 2008 at 07:20:42PM -0500, Leo Razoumov wrote:\n> On 12/10/08, Junio C Hamano wrote:\n> > \"Leo Razoumov\" writes:\n> >\n> > > BTW, for those of us without dblatex, is it possible to have pdf\n> > > manual pregenerated the same way html and man pages are pregenerated\n> > > for official releases in the git repo?\n> >\n> >\n> > Those of us includes myself, so...\n> \n> Ouch:-) Does it mean that such a useful patch has a low probability of\n> being accepted?\n\nFirst, just like the info pages, I don't think it's a problem at all if\nthe autogenerated pdf version is not part of git.git. I sent the patch\nto provide an easy way to do the pdf generation, not to request the\nautobuild of it as well.\n\nSecond, I think the autogeneration for pdf should not be done similar to\nthe man/html versions, as the pdf itself is 421K.\n\nHowever, I'm happy to set up a nightly cron job to build the pdf in case\nmaster is updated and/or there is a new release - in case there is\ndemand for that.\n"},{"id":"97556","messageId":"7v8wqny2az.fsf@gitster.siamese.dyndns.org","threadId":"16675","inReplyTo":"ee2a733e0812101620s5fc2ff27p81826a5ff827e154@mail.gmail.com","subject":"Re: [RFC/PATCH] Add support for a pdf version of the user manual","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-12-11T00:37:40Z","receivedAt":"2008-12-11T00:37:40Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Leo Razoumov\" writes:\n\n> On 12/10/08, Junio C Hamano wrote:\n>> \"Leo Razoumov\" writes:\n>>\n>> > BTW, for those of us without dblatex, is it possible to have pdf\n>> > manual pregenerated the same way html and man pages are pregenerated\n>> > for official releases in the git repo?\n>>\n>>\n>> Those of us includes myself, so...\n>\n> Ouch:-) Does it mean that such a useful patch has a low probability of\n> being accepted?\n\nAs an optional \"make\" target, as long as it works for people with the\nnecessary toolchain, I have no problem with the patch, but I would\ncomplain if the usual \"make doc\" try to run the tool I do not want to run\nwith my regular build. I didn't check.\n"}]}