git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: Matthieu Moy <Matthieu.Moy@grenoble-inp.fr>, git@vger.kernel.org
Subject: Re: [PATCH 3/3] api-credentials.txt: add "see also" section
Date: Tue, 5 Jun 2012 11:35:12 -0400	[thread overview]
Message-ID: <20120605153512.GA20148@sigill.intra.peff.net> (raw)
In-Reply-To: <7v1ultrdwi.fsf@alter.siamese.dyndns.org>

On Tue, Jun 05, 2012 at 08:12:29AM -0700, Junio C Hamano wrote:

> > Here is a simple fix. The Makefile bits are more hacky than I would
> > like. It would be really nice if the asciidoc macro could convert "we
> > are working on X/Y/Z.html" into "we need ../../ to get to the relative
> > base", but I don't think it is that flexible.
> >
> > We could also replace asciidoc with a wrapper script that does the
> > conversion and sets the appropriate attribute. I don't know if it is
> > worth the trouble. It's not like we add documentation subdirectories
> > very often.
> 
> Sorry, but I am not sure what problem is this trying to solve.  An
> API documentation page should only refer to command documentaion
> pages, and never another API documentation page that is at the same
> level?

No, but it should not use linkgit to do so (and if we did ever grow
linkgit targets in a subdirectory, it should call them with the full
directory name from the documentation root, just as documents in the
root would do).

-Peff

  reply	other threads:[~2012-06-05 15:35 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-06-03 16:10 [PATCH 0/3] Improve credential API documentation Matthieu Moy
2012-06-03 16:10 ` [PATCH 1/3] api-credential.txt: show the big picture first Matthieu Moy
2012-06-04 11:51   ` Jeff King
2012-06-03 16:10 ` [PATCH 2/3] api-credentials.txt: mention credential.helper explicitly Matthieu Moy
2012-06-04 11:54   ` Jeff King
2012-06-04 17:51     ` Matthieu Moy
2012-06-03 16:10 ` [PATCH 3/3] api-credentials.txt: add "see also" section Matthieu Moy
2012-06-03 22:28   ` Junio C Hamano
2012-06-04 11:31     ` Matthieu Moy
2012-06-04 11:56       ` Jeff King
2012-06-04 19:31         ` Junio C Hamano
2012-06-04 20:06         ` Matthieu Moy
2012-06-05  6:59           ` Jeff King
2012-06-05  7:34             ` Jeff King
2012-06-05 11:20               ` Matthieu Moy
2012-06-05 11:22                 ` Jeff King
2012-06-05 15:12               ` Junio C Hamano
2012-06-05 15:35                 ` Jeff King [this message]
2012-06-05 17:28                   ` Junio C Hamano
2012-06-04 20:17 ` [PATCH 1/4] doc: fix xref link from api docs to manual pages Matthieu Moy
2012-06-04 20:17   ` [PATCH 2/4 v2] api-credential.txt: show the big picture first Matthieu Moy
2012-06-05  7:36     ` Jeff King
2012-06-04 20:17   ` [PATCH 3/4 v2] api-credentials.txt: mention credential.helper explicitly Matthieu Moy
2012-06-04 20:17   ` [PATCH 4/4 v2] api-credentials.txt: add "see also" section Matthieu Moy

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=20120605153512.GA20148@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=Matthieu.Moy@grenoble-inp.fr \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).