All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: "David E. Wheeler" <david@justatheory.com>
Cc: git@vger.kernel.org
Subject: Re: Bad Man Page URLs
Date: Thu, 5 Apr 2012 22:32:23 -0400	[thread overview]
Message-ID: <20120406023223.GB16264@sigill.intra.peff.net> (raw)
In-Reply-To: <2AC038A1-3D8D-425E-92B3-DADFD027761A@justatheory.com>

On Thu, Apr 05, 2012 at 06:48:19PM -0700, David E. Wheeler wrote:

> I noticed this in 1.7.7.3, but just rebuilt 1.7.9.6 from source on OS
> X Lion and am still seeing it. These are the links at the end of `man
> git`:
> [...]
> >         1. Everyday Git
> >            file:///home/junio/share/doc/git-doc/everyday.html

The problem is that you are not really rebuilding the manpages at all,
but rather just untarring prebuilt copies. If you built them yourself,
they would have the proper prefix for your system.

That being said, it would be nice for the prebuilt manpages to have
something more location-agnostic in them. These links are generated by
asciidoc's "link:" directive. The HTML versions properly use relative
links, but the links are expanded into full URLs for the manpages. Which
makes sense, since there's no concept of a relative link here.

So we can tweak it by using a custom link macro (we already have
"linkgit" for linking to actual commands). But what should the agnostic
version say? Just saying "look at everday.html in the git documentation"
is not as nice as a real URL, but we really don't have any more
information than that. Maybe they should be pointing to some canonical
version on the web?

> Is there a bug reporting system I should report this to?

This list, and you just did. :)

-Peff

  reply	other threads:[~2012-04-06  2:33 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-04-06  1:48 Bad Man Page URLs David E. Wheeler
2012-04-06  2:32 ` Jeff King [this message]
2012-04-06  2:54   ` Jeff King
2012-04-06  4:22     ` Jonathan Nieder
2012-04-06  5:46       ` Jeff King
2012-04-06  6:17         ` Jonathan Nieder
2012-04-06  7:15         ` Junio C Hamano
2012-04-06  7:23           ` Jeff King
2012-04-26 20:12           ` David E. Wheeler
2012-04-26 20:19             ` Jonathan Nieder
2012-04-26 20:24               ` David E. Wheeler
2012-04-26 20:29                 ` Jonathan Nieder
2012-04-26 20:34                   ` David E. Wheeler
2012-05-02 21:46                     ` Jakub Narebski
2012-04-26 21:02               ` Jeff King
2012-04-26 21:58                 ` Scott Chacon
2012-04-26 22:11                   ` David E. Wheeler
2012-04-26 22:12                   ` Jonathan Nieder
2012-04-26 22:16                   ` Junio C Hamano
2012-04-26 22:25                     ` Scott Chacon
2012-04-26 22:34                       ` Jonathan Nieder

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20120406023223.GB16264@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=david@justatheory.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.