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

Re: [PATCH] Documentation/git-add.txt: Explain --patch option in layman terms

From
Jeff King <peff@peff.net>
Date
Aug 30, 2009, 21:02 UTC
Message-ID
<20090830210231.GA4471@coredump.intra.peff.net>
In-Reply-To
<7vab1hdppb.fsf@alter.siamese.dyndns.org>
On Sun, Aug 30, 2009 at 01:14:24PM -0700, Junio C Hamano wrote:
Show 11 quoted lines
> > -	operation to a subset of the working tree. See ``Interactive
> > -	mode'' for details.
> > +	operation to a subset of the working tree. See section
> > +	``INTERACTIVE MODE'' for details.
> 
> Sorry, the change in this hunk does not make *any* sense to me.
> 
> It is not justified with your commit log message, I do not see why you
> have to shout in all CAPS, and there is no such section in the
> documentation.  But the "Interactive mode" section exists and is referred
> to by the original.

I think it is an attempt to match the way docbook renders manpage headings; it converts headings to all-caps. And there is some precedent; try grepping for ".EXAMPLES" in Documentation/*.txt.

That being said, the straight asciidoc->html version leaves the capitalization untouched. However, that actually makes the html version look quite awkward. Some of the headings are in all-caps and some are not. So I wonder if we should make them typographically consistent.

(And yes, I totally agree that this hunk was a surprise after reading the commit message and if anything is done, it should be in a separate patch).

-Peff
Previous: Junio C HamanoNext: Jari Aalto
Message 3 of 21 in “Documentation/git-add.txt: Explain --patch option in layman terms”
  1. Documentation/git-add.txt: Explain --patch option in layman termsJari Aalto, Aug 30, 2009
  2. Junio C HamanoAug 30, 2009
  3. Jeff KingAug 30, 2009
  4. Jari AaltoAug 30, 2009
  5. Junio C HamanoAug 30, 2009
  6. Jari AaltoAug 30, 2009
  7. Junio C HamanoAug 30, 2009
  8. Jari AaltoAug 31, 2009
  9. Junio C HamanoAug 31, 2009
  10. Improve --patch option documentation in git-addJari Aalto, Sep 13, 2009
  11. Mikael MagnussonSep 13, 2009
  12. Jari AaltoSep 13, 2009
  13. Sean EstabrooksSep 14, 2009
  14. Jari AaltoSep 15, 2009
  15. Nanako ShiraishiSep 15, 2009
  16. Jari AaltoSep 15, 2009
  17. Nanako ShiraishiSep 15, 2009
  18. Junio C HamanoAug 30, 2009
  19. Jari AaltoAug 31, 2009
  20. Junio C HamanoAug 31, 2009
  21. Jari AaltoAug 30, 2009

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.