git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 3/3] api-credentials.txt: add "see also" section

From
Jeff King <peff@peff.net>
Date
Jun 5, 2012, 15:35 UTC
Message-ID
<20120605153512.GA20148@sigill.intra.peff.net>
In-Reply-To
<7v1ultrdwi.fsf@alter.siamese.dyndns.org>
On Tue, Jun 05, 2012 at 08:12:29AM -0700, Junio C Hamano wrote:
Show 14 quoted lines
> > 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
Previous: Junio C HamanoNext: Junio C Hamano
Message 18 of 24 in “Improve credential API documentation”
  1. 0/3 Improve credential API documentationMatthieu Moy, Jun 3, 2012
  2. 1/3 api-credential.txt: show the big picture firstMatthieu Moy, Jun 3, 2012
  3. Jeff KingJun 4, 2012
  4. 2/3 api-credentials.txt: mention credential.helper explicitlyMatthieu Moy, Jun 3, 2012
  5. Jeff KingJun 4, 2012
  6. Matthieu MoyJun 4, 2012
  7. 3/3 api-credentials.txt: add "see also" sectionMatthieu Moy, Jun 3, 2012
  8. Junio C HamanoJun 3, 2012
  9. Matthieu MoyJun 4, 2012
  10. Jeff KingJun 4, 2012
  11. Junio C HamanoJun 4, 2012
  12. Matthieu MoyJun 4, 2012
  13. Jeff KingJun 5, 2012
  14. Jeff KingJun 5, 2012
  15. Matthieu MoyJun 5, 2012
  16. Jeff KingJun 5, 2012
  17. Junio C HamanoJun 5, 2012
  18. Jeff KingJun 5, 2012
  19. Junio C HamanoJun 5, 2012
  20. 1/4 doc: fix xref link from api docs to manual pagesMatthieu Moy, Jun 4, 2012
  21. 2/4 api-credential.txt: show the big picture firstMatthieu Moy, Jun 4, 2012
  22. Jeff KingJun 5, 2012
  23. 3/4 api-credentials.txt: mention credential.helper explicitlyMatthieu Moy, Jun 4, 2012
  24. 4/4 api-credentials.txt: add "see also" sectionMatthieu Moy, Jun 4, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.