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

Re: [PATCH] doc/cat-file: clarify description regarding various command forms

From
Jeff King <peff@peff.net>
Date
Oct 9, 2023, 15:56 UTC
Message-ID
<20231009155603.GA3251575@coredump.intra.peff.net>
In-Reply-To
<20231009103651+0200.580831-stepnem@smrk.net>
On Mon, Oct 09, 2023 at 10:36:51AM +0200, Štěpán Němec wrote:
Show 8 quoted lines
> > Ah, true, I was thinking that the DESCRIPTION section would be the first
> > thing users would read, but I didn't notice the headline. I agree that
> > what it says is probably sufficient (though arguably "type and size" is
> > slightly inaccurate there; I said "details" in my proposed text but
> > maybe that is too vague).
> 
> We could also leave the NAME vague(r) and put an additional sentence at
> the beginning of DESCRIPTION:

Yup, that is a good suggestion. Do you want to wrap all of this discussion up as a patch?

-Peff
Previous: Štěpán NěmecNext: Štěpán Němec
Message 8 of 11 in “doc/cat-file: clarify description regarding various command forms”
  1. doc/cat-file: clarify description regarding various command formsŠtěpán Němec, Oct 3, 2023
  2. Jeff KingOct 3, 2023
  3. Štěpán NěmecOct 5, 2023
  4. Jeff KingOct 5, 2023
  5. Štěpán NěmecOct 5, 2023
  6. Jeff KingOct 5, 2023
  7. Štěpán NěmecOct 9, 2023
  8. Jeff KingOct 9, 2023
  9. doc/cat-file: make synopsis and description less confusingŠtěpán Němec, Oct 9, 2023
  10. Jeff KingOct 9, 2023
  11. Junio C HamanoOct 9, 2023

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.