{"thread":{"id":"21834","subject":"[RFC PATCH] Documentation: set a base URL for relative links","startedAt":"2009-12-03T01:50:05Z","lastAt":"2009-12-03T02:16:08Z","messageCount":2,"participants":["Todd Zullinger","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"129092","messageId":"20091203015005.GH23717@inocybe.localdomain","threadId":"21834","inReplyTo":null,"subject":"[RFC PATCH] Documentation: set a base URL for relative links","fromName":"Todd Zullinger","fromEmail":"tmz@pobox.com","sentAt":"2009-12-03T01:50:05Z","receivedAt":"2009-12-03T01:50:05Z","isPatch":true,"sender":{"key":"tmz@pobox.com","avatar":"https://avatars.githubusercontent.com/u/806319?v=4"},"body":"The man.base.url.for.relative.links setting is used when generating the\nNOTES sections of various man pages.  If unset, the output looks like\nthis:\n\n        1. Everyday Git\n           [set $man.base.url.for.relative.links]/everyday.html\n\nReported-by: Michal Schmidt (Fedora bug #543481)\nSigned-off-by: Todd Zullinger <tmz@pobox.com>\n---\n\nThis was reported to the Fedora bugzilla.  I checked and it's been\nbroken in the Fedora builds for quite a while.  In origin/man, the\nfirst time it appeared was 3ae5cb60 (Autogenerated manpages for\nv1.6.5.1-75-g02d56), which looks to be around the time that kernel.org\nswitched from F9 to F11.\n\nI don't know the doc toolchain well enough to know how best to fix\nthis without breaking anything.  It would be ideal if the base URL\nused was substituted and controllable via make variables.  That would\nallow packagers to make it point to the on-disk documentation and make\ngit's documentation even easier to use when disconnected.\n\nAny help or suggestions to refine this and test it on various docbook\nversions would be most welcome.\n\n Documentation/manpage-base.xsl |    4 ++++\n 1 files changed, 4 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/manpage-base.xsl b/Documentation/manpage-base.xsl\nindex a264fa6..50ce029 100644\n--- a/Documentation/manpage-base.xsl\n+++ b/Documentation/manpage-base.xsl\n@@ -7,6 +7,10 @@\n <xsl:param name=\"man.output.quietly\" select=\"1\"/>\n <xsl:param name=\"refentry.meta.get.quietly\" select=\"1\"/>\n \n+<!-- set a base URL for relative links -->\n+<xsl:param name=\"man.base.url.for.relative.links\"\n+\t>http://www.kernel.org/pub/software/scm/git/docs/</xsl:param>\n+\n <!-- convert asciidoc callouts to man page format;\n      git.docbook.backslash and git.docbook.dot params\n      must be supplied by another XSL file or other means -->\n-- \n1.6.6.rc0\n\n-- \nTodd        OpenPGP -> KeyID: 0xBEAF0CE3 | URL: www.pobox.com/~tmz/pgp\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nJust because everything is different doesn't mean anything has\nchanged.\n    -- Irene Peter\n"},{"id":"129094","messageId":"7vy6lk7qfr.fsf@alter.siamese.dyndns.org","threadId":"21834","inReplyTo":"20091203015005.GH23717@inocybe.localdomain","subject":"Re: [RFC PATCH] Documentation: set a base URL for relative links","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2009-12-03T02:16:08Z","receivedAt":"2009-12-03T02:16:08Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Todd Zullinger <tmz@pobox.com> writes:\n\n> I don't know the doc toolchain well enough to know how best to fix\n> this without breaking anything.  It would be ideal if the base URL\n> used was substituted and controllable via make variables.  That would\n> allow packagers to make it point to the on-disk documentation and make\n> git's documentation even easier to use when disconnected.\n\nThanks. It indeed appears that update to FC11 at k.org brought a few\nissues to the documentation area.\n\nI think we can do something like this and let distro people to decide what\nURL to use.\n\n Documentation/Makefile |    4 ++++\n 1 files changed, 4 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex 3f59952..abb75eb 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -104,6 +104,10 @@ ifdef DOCBOOK_SUPPRESS_SP\n XMLTO_EXTRA += -m manpage-suppress-sp.xsl\n endif\n \n+ifdef MAN_BASE_URL\n+XMLTO_EXTRA += --stringparam man.base.url.for.relative.links=$(MAN_BASE_URL)\n+endif\n+\n # If your target system uses GNU groff, it may try to render\n # apostrophes as a \"pretty\" apostrophe using unicode.  This breaks\n # cut&paste, so you should set GNU_ROFF to force them to be ASCII\n"}]}