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

Re: [PATCH] Document the fact that commit -a is the way to go for simple operations

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
May 7, 2007, 11:22 UTC
Message-ID
<Pine.LNX.4.64.0705071317580.4167@racer.site>
In-Reply-To
<vpqy7k1t56i.fsf@bauges.imag.fr>
Hi,

[BTW Matthieu, it seems you suffer the same problem as Jakub, since you do not Cc the original authors in your replies.]

On Mon, 7 May 2007, Matthieu Moy wrote:
Show 9 quoted lines
> My proposal is not perfect, and I'm sure we can do better.
> 
> But the problem with most of git's manpages for beginners is that the
> documentation is mostly technical and factual. That is, it tells you
> what git will do if you provide such or such option, but not _why_ and
> _when_ you should use it.
> 
> Probably just a "gitlink:" to the place in the user manual which talks
> about the index would be OK here.

NAK. You should not even consider reading the man pages before reading the user manual. If you expect the man pages to give you a proper introduction into _anything_ that is your problem, not the doc's.

We have such a lovely user manual, full of examples, a nice read, and it even contains a section for the impatient. But the man pages are _meant_ to be technical. And I do not see a place in them for a back reference to the user manual.

Ciao, Dscho

Previous: Matthieu Moy
Message 10 of 10 in “Document the fact that commit -a is the way to go for simple operations”
  1. Document the fact that commit -a is the way to go for simple operationsMatthieu Moy, May 6, 2007
  2. Document git add -u introduced earlier.Matthieu Moy, May 6, 2007
  3. Added a reference to git-add in the documentation for git-update-indexMatthieu Moy, May 6, 2007
  4. Document "commit --only".Matthieu Moy, May 6, 2007
  5. Nicolas PitreMay 6, 2007
  6. Matthieu MoyMay 7, 2007
  7. Matthieu MoyMay 7, 2007
  8. Nicolas PitreMay 6, 2007
  9. Matthieu MoyMay 7, 2007
  10. Johannes SchindelinMay 7, 2007

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.