{"thread":{"id":"30854","subject":"Missing hyperlinks in HTML docs","startedAt":"2012-06-20T20:43:08Z","lastAt":"2012-06-21T23:58:05Z","messageCount":3,"participants":["Michael Hertling","Jeff King"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"193994","messageId":"4FE235DC.9080202@online.de","threadId":"30854","inReplyTo":null,"subject":"Missing hyperlinks in HTML docs","fromName":"Michael Hertling","fromEmail":"mhertling@online.de","sentAt":"2012-06-20T20:43:08Z","receivedAt":"2012-06-20T20:43:08Z","isPatch":false,"sender":{"key":"mhertling@online.de","avatar":null},"body":"Dear Git community,\n\nbeginning with v1.7.11-rc3, some HTML docs built along with Git\nare lacking hyperlinks on my system. Steps to reproduce, e.g.:\n\ngunzip -c git-1.7.11.rc3.tar.gz | tar xf -\n(cd git-1.7.11.rc3 && ./configure && make -C Documentation git.html)\n\nThe resulting git.html does not have hyperlinks to the individual\nGit commands, making this file somewhat useless. Doing the same\nwith v1.7.11-rc2, i.e.\n\ngunzip -c git-1.7.11.rc2.tar.gz | tar xf -\n(cd git-1.7.11.rc2 && ./configure && make -C Documentation git.html)\n\nshows that git.html does have the expected hyperlinks; e.g., diffing\ngit-1.7.11.rc{2,3}/Documentation/git.html reveals the following hunk:\n\n@@ -964,7 +964,6 @@\n <h3 id=\"_main_porcelain_commands\">Main porcelain commands</h3>\n <div class=\"dlist\"><dl>\n <dt class=\"hdlist1\">\n-<a href=\"git-add.html\">git-add(1)</a>\n </dt>\n <dd>\n <p>\n\nOther files, e.g. git-add.html, are affected, too.\n\nAFAICS, this is caused by fe77b41, more precisely the change of the\nDocumentation/asciidoc.conf file. Indeed, reverting that commit on\nv1.7.11-rc3 results in git.html containing hyperlinks as expected.\n\nCan anyone confirm this? If so, is this intended behaviour? So far,\nI haven't found any clues in the release notes / mailing list / etc.\nAm I doing something wrong? Do I miss something? Thanks for any hint.\n\nRegards,\n\nMichael\n"},{"id":"194018","messageId":"20120621062410.GB19485@sigill.intra.peff.net","threadId":"30854","inReplyTo":"4FE235DC.9080202@online.de","subject":"Re: Missing hyperlinks in HTML docs","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2012-06-21T06:24:10Z","receivedAt":"2012-06-21T06:24:10Z","isPatch":false,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Wed, Jun 20, 2012 at 10:43:08PM +0200, Michael Hertling wrote:\n\n> shows that git.html does have the expected hyperlinks; e.g., diffing\n> git-1.7.11.rc{2,3}/Documentation/git.html reveals the following hunk:\n> \n> @@ -964,7 +964,6 @@\n>  <h3 id=\"_main_porcelain_commands\">Main porcelain commands</h3>\n>  <div class=\"dlist\"><dl>\n>  <dt class=\"hdlist1\">\n> -<a href=\"git-add.html\">git-add(1)</a>\n>  </dt>\n>  <dd>\n>  <p>\n> \n> Other files, e.g. git-add.html, are affected, too.\n> \n> AFAICS, this is caused by fe77b41, more precisely the change of the\n> Documentation/asciidoc.conf file. Indeed, reverting that commit on\n> v1.7.11-rc3 results in git.html containing hyperlinks as expected.\n> \n> Can anyone confirm this? If so, is this intended behaviour? So far,\n> I haven't found any clues in the release notes / mailing list / etc.\n> Am I doing something wrong? Do I miss something? Thanks for any hint.\n\nEek. I can easily replicate it here. The problem is that the new\ngit-relative-html-prefix attribute is not defined by default (whereas we\nwant it defined but blank). Which puzzles me, as I thought I tested how\nfe77b41 impacted files outside of technical/. But obviously I screwed\nsomething up.\n\nThe patch below should solve it.\n\n-- >8 --\nSubject: docs: always define git-relative-html-prefix attribute\n\nCommit fe77b41 introduced a new attribute to let the linkgit macro\ncreate cross-directory HTML references from the technical/ and howto/\nsubdirectories back to the main documentation. We define that attribute\nto \"../\" on the command-line when building inside those subdirectories,\nand otherwise leave it unset under the assumption that it would default\nto being blank.  Instead, asciidoc omits the link entirely, leading to\nbroken documentation. Fix this by defining git-relative-html-prefix to\nblank in asciidoc.conf (and an instance on the command-line, when\npresent, will override it).\n\nSigned-off-by: Jeff King <peff@peff.net>\n---\n Documentation/asciidoc.conf | 2 ++\n 1 file changed, 2 insertions(+)\n\ndiff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf\nindex 6d06271..a26d245 100644\n--- a/Documentation/asciidoc.conf\n+++ b/Documentation/asciidoc.conf\n@@ -90,6 +90,8 @@ endif::backend-docbook[]\n endif::doctype-manpage[]\n \n ifdef::backend-xhtml11[]\n+[attributes]\n+git-relative-html-prefix=\n [linkgit-inlinemacro]\n <a href=\"{git-relative-html-prefix}{target}.html\">{target}{0?({0})}</a>\n endif::backend-xhtml11[]\n"},{"id":"194053","messageId":"4FE3B50D.2070200@online.de","threadId":"30854","inReplyTo":"20120621062410.GB19485@sigill.intra.peff.net","subject":"Re: Missing hyperlinks in HTML docs","fromName":"Michael Hertling","fromEmail":"mhertling@online.de","sentAt":"2012-06-21T23:58:05Z","receivedAt":"2012-06-21T23:58:05Z","isPatch":false,"sender":{"key":"mhertling@online.de","avatar":null},"body":"On 06/21/2012 08:24 AM, Jeff King wrote:\n\n> The patch below should solve it.\n\nYes, it does. Many thanks for your quick reply and the patch.\n\nRegards,\n\nMichael\n"}]}