{"thread":{"id":"15475","subject":"[PATCH 2/2] separate build targets for man and html documentation","startedAt":"2008-09-09T20:44:17Z","lastAt":"2008-09-10T09:16:53Z","messageCount":4,"participants":["Michael J Gruber"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"90332","messageId":"1082ea29216aba63f5d2b13763eeceebe46e0691.1221035620.git.michaeljgruber+gmane@fastmail.fm","threadId":"15475","inReplyTo":"cover.1221035620.git.michaeljgruber+gmane@fastmail.fm","subject":"[PATCH 1/2] allow installation of man and html doc from the man and html branches","fromName":"Michael J Gruber","fromEmail":"michaeljgruber+gmane@fastmail.fm","sentAt":"2008-09-09T20:44:17Z","receivedAt":"2008-09-09T20:44:17Z","isPatch":true,"sender":{"key":"git@grubix.eu","avatar":"https://avatars.githubusercontent.com/u/233215?v=4"},"body":"This patch introduces a make target \"quick-install-html\" which installs\nthe html documentation from the branch origin/html, without the need for\nasciidoc/xmlto. This is analogous to the existing \"quick-install-doc\"\ntarget for the man pages.\n\nWe advertise these targets in the INSTALL file now.\n\nSigned-off-by: Michael J Gruber <michaeljgruber+gmane@fastmail.fm>\n---\n Documentation/Makefile |    4 ++++\n INSTALL                |    5 +++++\n Makefile               |    3 +++\n 3 files changed, 12 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex 62269e3..ded0e40 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -44,6 +44,7 @@ MANPAGE_XSL = callouts.xsl\n INSTALL?=install\n RM ?= rm -f\n DOC_REF = origin/man\n+HTML_REF = origin/html\n \n infodir?=$(prefix)/share/info\n MAKEINFO=makeinfo\n@@ -222,4 +223,7 @@ install-webdoc : html\n quick-install:\n \tsh ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)\n \n+quick-install-html:\n+\tsh ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)\n+\n .PHONY: .FORCE-GIT-VERSION-FILE\ndiff --git a/INSTALL b/INSTALL\nindex 2bae53f..7c13473 100644\n--- a/INSTALL\n+++ b/INSTALL\n@@ -117,6 +117,11 @@ Issues of note:\n \n \thttp://www.kernel.org/pub/software/scm/git/docs/\n \n+   There is also \"make quick-install-doc\" and \"make quick-install-html\"\n+   which installs man pages resp. html documentation from these branches.\n+   This does not require asciidoc/xmlto, but it works from within\n+   a checkout of git.git only.\n+\n    It has been reported that docbook-xsl version 1.72 and 1.73 are\n    buggy; 1.72 misformats manual pages for callouts, and 1.73 needs\n    the patch in contrib/patches/docbook-xsl-manpages-charmap.patch\ndiff --git a/Makefile b/Makefile\nindex f4c31c8..eeaf6d4 100644\n--- a/Makefile\n+++ b/Makefile\n@@ -1401,6 +1401,9 @@ install-info:\n quick-install-doc:\n \t$(MAKE) -C Documentation quick-install\n \n+quick-install-html:\n+\t$(MAKE) -C Documentation quick-install-html\n+\n \n \n ### Maintainer's dist rules\n-- \n1.6.0.1.285.g1070\n"},{"id":"90331","messageId":"81ce09dd0ac69ee7e09731e3ad26ff7cd1ab0765.1221035620.git.michaeljgruber+gmane@fastmail.fm","threadId":"15475","inReplyTo":"cover.1221035620.git.michaeljgruber+gmane@fastmail.fm","subject":"[PATCH 2/2] separate build targets for man and html documentation","fromName":"Michael J Gruber","fromEmail":"michaeljgruber+gmane@fastmail.fm","sentAt":"2008-09-10T08:19:34Z","receivedAt":"2008-09-10T08:19:34Z","isPatch":true,"sender":{"key":"git@grubix.eu","avatar":"https://avatars.githubusercontent.com/u/233215?v=4"},"body":"This introduces new build targets \"man\" and \"html\" which allow building\nthe documentation in the respective formats separately. This helps\npeople with a partial documentation build chain: html pages can be built\nwithout xmlto.\n\nThis is documented in INSTALL now, together with corrections: Before,\ninstructions in INSTALL would build man+html but install man only. Now\nthe instructions build and install both, and new and pre-existing\ntargets are explained.\n\nNote that build targets \"doc\" and \"man\" correspond to install targets\n\"install-doc install-html\" and \"install-doc\" respectively. This\ninconsistency is not changed, in order to keep everyone's build scripts\nfrom breaking.\n\nSigned-off-by: Michael J Gruber <michaeljgruber+gmane@fastmail.fm>\n---\n INSTALL  |   15 ++++++++++++---\n Makefile |    6 ++++++\n 2 files changed, 18 insertions(+), 3 deletions(-)\n\ndiff --git a/INSTALL b/INSTALL\nindex 7c13473..a40d77d 100644\n--- a/INSTALL\n+++ b/INSTALL\n@@ -6,7 +6,7 @@ will install the git programs in your own ~/bin/ directory.  If you want\n to do a global install, you can do\n \n \t$ make prefix=/usr all doc info ;# as yourself\n-\t# make prefix=/usr install install-doc install-info ;# as root\n+\t# make prefix=/usr install install-doc install-html install-info ;# as root\n \n (or prefix=/usr/local, of course).  Just like any program suite\n that uses $prefix, the built results have some paths encoded,\n@@ -19,7 +19,7 @@ set up install paths (via config.mak.autogen), so you can write instead\n \t$ make configure ;# as yourself\n \t$ ./configure --prefix=/usr ;# as yourself\n \t$ make all doc ;# as yourself\n-\t# make install install-doc ;# as root\n+\t# make install install-doc install-html;# as root\n \n \n Issues of note:\n@@ -89,13 +89,22 @@ Issues of note:\n    inclined to install the tools, the default build target\n    (\"make all\") does _not_ build them.\n \n+   \"make doc\" builds documentation in man and html formats; there are\n+   also \"make man\", \"make html\" and \"make info\". Note that \"make html\"\n+   requires asciidoc, but not xmlto. \"make man\" (and thus make doc)\n+   requires both.\n+\n+   \"make install-doc\" installs documentation in man format only; there\n+   are also \"make install-man\", \"make install-html\" and \"make\n+   install-info\".\n+\n    Building and installing the info file additionally requires\n    makeinfo and docbook2X.  Version 0.8.3 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 \n-   Alternatively, pre-formatted documentation are available in\n+   Alternatively, pre-formatted documentation is available in\n    \"html\" and \"man\" branches of the git repository itself.  For\n    example, you could:\n \ndiff --git a/Makefile b/Makefile\nindex eeaf6d4..66e1982 100644\n--- a/Makefile\n+++ b/Makefile\n@@ -1265,6 +1265,12 @@ $(XDIFF_LIB): $(XDIFF_OBJS)\n doc:\n \t$(MAKE) -C Documentation all\n \n+man:\n+\t$(MAKE) -C Documentation man\n+\n+html:\n+\t$(MAKE) -C Documentation html\n+\n info:\n \t$(MAKE) -C Documentation info\n \n-- \n1.6.0.1.285.g1070\n"},{"id":"90333","messageId":"cover.1221035620.git.michaeljgruber+gmane@fastmail.fm","threadId":"15475","inReplyTo":null,"subject":"[PATCH 0/2] Assist installing documentation with incomplete build chain","fromName":"Michael J Gruber","fromEmail":"michaeljgruber+gmane@fastmail.fm","sentAt":"2008-09-10T08:33:40Z","receivedAt":"2008-09-10T08:33:40Z","isPatch":true,"sender":{"key":"git@grubix.eu","avatar":"https://avatars.githubusercontent.com/u/233215?v=4"},"body":"This patch series should clarify make targets for documentation and\nhelp those with partial or no documentation build chain, without breaking\nexisting behaviour. Therefore, the current inconsistency between \"make\ndoc\" (builds man and html doc) and \"make install-doc\" (installs man) is\npreserved.\n\nThe INSTALL file documents this now, as well as preexisting and new\ntargets for building and installing man and html separately or from the\nconvenience branches origin/{man,html}.\n\nMichael J Gruber (2):\n  allow installation of man and html doc from the man and html branches\n  separate build targets for man and html documentation\n\n Documentation/Makefile |    4 ++++\n INSTALL                |   20 +++++++++++++++++---\n Makefile               |    9 +++++++++\n 3 files changed, 30 insertions(+), 3 deletions(-)\n"},{"id":"90334","messageId":"48C79085.6090005@fastmail.fm","threadId":"15475","inReplyTo":"cover.1221035620.git.michaeljgruber+gmane@fastmail.fm","subject":"Re: [PATCH 0/2] Assist installing documentation with incomplete build chain","fromName":"Michael J Gruber","fromEmail":"michaeljgruber+gmane@fastmail.fm","sentAt":"2008-09-10T09:16:53Z","receivedAt":"2008-09-10T09:16:53Z","isPatch":true,"sender":{"key":"git@grubix.eu","avatar":"https://avatars.githubusercontent.com/u/233215?v=4"},"body":"I hate to reply to myself, but I apologize for the failed threading.\nThat series has Message-Id: and In-Reply-To: fields set up\nappropriately, but it doesn't show up threaded, at least not here. It\nwas an attempt at using Thunderbird, by writing format-patch output to\nTB's outbox in mbox format (and adding a few lines). I'll try\ndifferently next time (the approach with external editor + TB-config\nchanges isn't that comfortable either).\n\nMichael\n"}]}