{"thread":{"id":"2936","subject":"[ANNOUNCE] GIT preformatted documentation available.","startedAt":"2005-12-27T08:49:17Z","lastAt":"2005-12-28T16:51:37Z","messageCount":2,"participants":["Junio C Hamano","Adrien Beau"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"14059","messageId":"7vu0cuc4c2.fsf@assigned-by-dhcp.cox.net","threadId":"2936","inReplyTo":null,"subject":"[ANNOUNCE] GIT preformatted documentation available.","fromName":"Junio C Hamano","fromEmail":"junkio@cox.net","sentAt":"2005-12-27T08:49:17Z","receivedAt":"2005-12-27T08:49:17Z","isPatch":false,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"I was asked to provide pre-formatted man pages (and perhaps html\npages), since the time of kernel developers are better spent on\nwhat they do best, rather than preparing the xmlto toolchain.\n\nI was planning to do a tarball every time I do a \"release\", but\nthat would mean it is no better than the current way --- you\ncould extract manpages out of rpm anyway.\n\nSo instead, I'll do independent branches \"html\" and \"man\" in\ngit.git repository to keep the preformatted documentation.\n\n\t$ mkdir git.man ; cd git.man\n\t$ git init-db\n        $ ID=$(git fetch-pack -k git://git.kernel.org/pub/scm/git/git man)\n        $ expr \"$ID\" : '\\(.*\\) .*' >.git/refs/heads/master\n        $ cat .git/refs/heads/master >.git/refs/heads/origin\n\t$ git checkout; /bin/ls -aF\n\t./  ../  .git/\tman1/  man7/\n        $ echo >.git/remotes/origin <<\\EOF\n        URL: git://git.kernel.org/pub/scm/git/git\n        Pull: man:origin\n        EOF\n\nWould set you up, and you can\nto keep them up-to-date, and install them like so:\n\n\t$ cd git.man\n\t$ git pull\n\t$ cp -a man1 man7 /usr/local/man/\n\nThe \"html\" branch is similar; it is a copy of what is shown at\nhttp://www.kernel.org/pub/software/scm/git/docs/.\n\nThis means if you clone from git.git repository, you would end\nup with something like this in .git/remotes/origin file:\n\n\tURL: git://git.kernel.org/pub/scm/git/git.git\n        Pull: master:origin\n        Pull: todo:todo\n        Pull: html:html\n        Pull: man:man\n        Pull: pu:pu\n        Pull: maint:maint\n\nTypically, for the repository to track GIT itself, you would\nwant to trim them like this:\n\n\tURL: git://git.kernel.org/pub/scm/git/git.git\n        Pull: master:origin\n        Pull: maint:maint\n        Pull: +pu:pu\n"},{"id":"14090","messageId":"94fc236b0512280851n797ecbedjecae3f8131b84369@mail.gmail.com","threadId":"2936","inReplyTo":"7vu0cuc4c2.fsf@assigned-by-dhcp.cox.net","subject":"Re: [ANNOUNCE] GIT preformatted documentation available.","fromName":"Adrien Beau","fromEmail":"adrienbeau@gmail.com","sentAt":"2005-12-28T16:51:37Z","receivedAt":"2005-12-28T16:51:37Z","isPatch":false,"sender":{"key":"adrienbeau@gmail.com","avatar":null},"body":"On 12/27/05, Junio C Hamano <junkio@cox.net> wrote:\n>\n> I was asked to provide pre-formatted man pages (and perhaps html\n> pages), since the time of kernel developers are better spent on\n> what they do best, rather than preparing the xmlto toolchain.\n>\n> I was planning to do a tarball every time I do a \"release\", but\n> that would mean it is no better than the current way --- you\n> could extract manpages out of rpm anyway.\n>\n> So instead, I'll do independent branches \"html\" and \"man\" in\n> git.git repository to keep the preformatted documentation.\n\nHaving preformatted documentation is a great step forward, but it\nwould be even better if we could have it without installing some weird\nRPM tool or a local copy of the Git repository -- not all my machines\nhave that.\n\nBesides, it's not very beginner- or newcomer-friendly. Grab the\nsource; discover you need a complex toolchain to have manpages; maybe\nlearn sometime later that \"all you had to do\" was get an RPM and\nexplode some parts of it -- nah, it just doesn't feel right.\n\nYou're already generating five RPMs and two tarballs everytime you\nrelease a version, would it be much more taxing to generate a third\ntarball?\n\nThat said, those two new branches are neat. Thanks!\n"}]}