{"thread":{"id":"3122","subject":"[PATCH] Mention install-doc in INSTALL","startedAt":"2006-01-21T23:54:12Z","lastAt":"2006-01-22T18:12:54Z","messageCount":4,"participants":["J. Bruce Fields","Petr Baudis","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"15015","messageId":"E1F0SYe-0005ix-WB@puzzle.fieldses.org","threadId":"3122","inReplyTo":null,"subject":"[PATCH] Mention install-doc in INSTALL","fromName":"J. Bruce Fields","fromEmail":"bfields@fieldses.org","sentAt":"2006-01-21T23:54:12Z","receivedAt":"2006-01-21T23:54:12Z","isPatch":true,"sender":{"key":"bfields@citi.umich.edu","avatar":null},"body":"I think most people will want to install the man pages as well.\n\n(I'm less sure about the case of the home directory, as I assume there's\nunlikely to be a reasonable place to install man pages to in that case.)\n\nSigned-off-by: J. Bruce Fields \n\n---\n\n INSTALL | 2 +-\n 1 files changed, 1 insertions(+), 1 deletions(-)\n\n81333d4427d75d039c6b5b5bd3c5b71e236ff187\ndiff --git a/INSTALL b/INSTALL\nindex 916ddd4..6fb826a 100644\n--- a/INSTALL\n+++ b/INSTALL\n@@ -6,7 +6,7 @@ will install the git programs in your ow\n to do a global install, you can do\n \n \t$ make prefix=/usr ;# as yourself\n-\t# make prefix=/usr install ;# as root\n+\t# make prefix=/usr install install-doc ;# 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-- \n0.99.8b-g58e3\n"},{"id":"15016","messageId":"20060122001255.GR28365@pasky.or.cz","threadId":"3122","inReplyTo":"E1F0SYe-0005ix-WB@puzzle.fieldses.org","subject":"Re: [PATCH] Mention install-doc in INSTALL","fromName":"Petr Baudis","fromEmail":"pasky@suse.cz","sentAt":"2006-01-22T00:12:55Z","receivedAt":"2006-01-22T00:12:55Z","isPatch":true,"sender":{"key":"pasky@ucw.cz","avatar":"https://avatars.githubusercontent.com/u/18439?v=4"},"body":"Dear diary, on Sun, Jan 22, 2006 at 12:54:12AM CET, I got a letter\nwhere \"J. Bruce Fields\" said that...\n> I think most people will want to install the man pages as well.\n> \n> (I'm less sure about the case of the home directory, as I assume there's\n> unlikely to be a reasonable place to install man pages to in that case.)\n> \n> Signed-off-by: J. Bruce Fields \n\nBut you really do not want to build the documentation as root.\nCogito's \"solution\" is:\n\ndiff --git a/INSTALL b/INSTALL\nindex 916ddd4..464bfbb 100644\n--- a/INSTALL\n+++ b/INSTALL\n@@ -90,3 +90,10 @@ Issues of note:\n You can place local settings in config.mak and the Makefile\n will include them. Note that config.mak is not distributed;\n the name is reserved for local settings.\n+\n+ - By default, separate documentation (manpages, text, HTML) is not built\n+ since it requires asciidoc and xmlto, and those tools are not so common.\n+ You can build it by \"make doc\" and install it later by \"make install-doc\"\n+ in the project root, or you can build directly in the \"Documentation/\"\n+ subdirectory, where you can also choose to build only documentation in\n+ particular format. See Documentation/Makefile for further details.\n\n-- \n\t\t\t\tPetr \"Pasky\" Baudis\nStuff: http://pasky.or.cz/\nOf the 3 great composers Mozart tells us what it's like to be human,\nBeethoven tells us what it's like to be Beethoven and Bach tells us\nwhat it's like to be the universe. -- Douglas Adams\n"},{"id":"15027","messageId":"7vr771gcu9.fsf@assigned-by-dhcp.cox.net","threadId":"3122","inReplyTo":"20060122001255.GR28365@pasky.or.cz","subject":"Re: [PATCH] Mention install-doc in INSTALL","fromName":"Junio C Hamano","fromEmail":"junkio@cox.net","sentAt":"2006-01-22T03:29:02Z","receivedAt":"2006-01-22T03:29:02Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Petr Baudis writes:\n\n> But you really do not want to build the documentation as root.\n\nTrue.\n\n> Cogito's \"solution\" is:\n>\n> + - By default, separate documentation (manpages, text, HTML) is not built\n> + since it requires asciidoc and xmlto, and those tools are not so common.\n\nThat's cheating ;-), but I cannot blame you.\n\nI'll push out this hopefully tonight.\n\n---\nFrom: J. Bruce Fields \nDate: Sat Jan 21 18:54:12 2006 -0500\n[PATCH] Mention install-doc in INSTALL\n\nI think most people will want to install the man pages as well.\n\n[jc: incorporated Pasky's comment on not building them as root.\nSome people may not want to install asciidoc/xmlto toolchain, so\nredirect them to the man and html branches of the git.git\nrepository as well.]\n\nSigned-off-by: J. Bruce Fields \nSigned-off-by: Junio C Hamano \n\n---\n\n INSTALL | 28 ++++++++++++++++++++++++++--\n 1 files changed, 26 insertions(+), 2 deletions(-)\n\neff351c957975055643f2e1359652ab3aac30256\ndiff --git a/INSTALL b/INSTALL\nindex 916ddd4..433449f 100644\n--- a/INSTALL\n+++ b/INSTALL\n@@ -5,8 +5,8 @@ Normally you can just do \"make\" followed\n 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 ;# as yourself\n-\t# make prefix=/usr install ;# as root\n+\t$ make prefix=/usr all doc ;# as yourself\n+\t# make prefix=/usr install install-doc ;# 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@@ -90,3 +90,27 @@ Issues of note:\n You can place local settings in config.mak and the Makefile\n will include them. Note that config.mak is not distributed;\n the name is reserved for local settings.\n+\n+ - To build and install documentation suite, you need to have the\n+ asciidoc/xmlto toolchain. Alternatively, pre-formatted\n+ documentation are available in \"html\" and \"man\" branches of the git\n+ repository itself. For example, you could:\n+\n+\t$ mkdir manual && cd manual\n+\t$ git init-db\n+\t$ git clone-pack git://git.kernel.org/pub/scm/git/git.git man html |\n+\t while read a b\n+\t do\n+\t echo $a >.git/$b\n+\t done\n+\t$ cp .git/refs/heads/man .git/refs/heads/master\n+\t$ git checkout\n+\n+ to checkout the pre-built man pages. Also in this repository:\n+\n+\t$ git checkout html\n+\n+ would instead give you a copy of what you see at:\n+\n+\thttp://www.kernel.org/pub/software/scm/git/docs/\n+\n-- \n1.1.4.g73f3\n"},{"id":"15041","messageId":"20060122181254.GF31954@fieldses.org","threadId":"3122","inReplyTo":"7vr771gcu9.fsf@assigned-by-dhcp.cox.net","subject":"Re: [PATCH] Mention install-doc in INSTALL","fromName":"J. Bruce Fields","fromEmail":"bfields@fieldses.org","sentAt":"2006-01-22T18:12:54Z","receivedAt":"2006-01-22T18:12:54Z","isPatch":true,"sender":{"key":"bfields@citi.umich.edu","avatar":null},"body":"On Sat, Jan 21, 2006 at 07:29:02PM -0800, Junio C Hamano wrote:\n> Petr Baudis writes:\n> \n> > But you really do not want to build the documentation as root.\n> \n> True.\n> \n> > Cogito's \"solution\" is:\n> >\n> > + - By default, separate documentation (manpages, text, HTML) is not built\n> > + since it requires asciidoc and xmlto, and those tools are not so common.\n> \n> That's cheating ;-), but I cannot blame you.\n> \n> I'll push out this hopefully tonight.\n\nLooks good to me; thanks!--b.\n"}]}