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

Re: [PATCH] Documentation: convert "glossary" and "core-tutorial" to man pages

From
Jakub Narebski <jnareb@gmail.com>
Date
May 4, 2008, 11:13 UTC
Message-ID
<200805041313.03499.jnareb@gmail.com>
In-Reply-To
<20080504122157.ca98c75d.chriscool@tuxfamily.org>
On Sun, 4. May 2008, Christian Couder wrote:
Show 5 quoted lines
> This patch renames the following documents and at the same time converts
> them to the man format:
> 
> core-tutorial.txt -> gitcore-tutorial.txt
> glossary.txt      -> gitglossary.txt

I like this, although I think that perhaps git-core-tutorial.txt would be a better filename.

Show 5 quoted lines
> But as the glossary is included in the user manual and as the new
> gitglossary man page cannot be included as a whole in the user manual,
> the actual glossary content is now in its own "glossary-content.txt"
> new file. And this file is included by both the user manual and the
> gitglossary man page.

Another solution would be to use conditionals. I'm not sure which one is better; I guess the include one...

-- 
Jakub Narebski
Poland
Previous: Christian CouderNext: Pieter de Bie
Message 2 of 5 in “Documentation: convert "glossary" and "core-tutorial" to man pages”
  1. Documentation: convert "glossary" and "core-tutorial" to man pagesChristian Couder, May 4, 2008
  2. Jakub NarebskiMay 4, 2008
  3. Pieter de BieMay 4, 2008
  4. Jakub NarebskiMay 4, 2008
  5. Ping YinMay 5, 2008

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.