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

Re: [PATCH 7/8] CodingGuidelines: on comparison

From
Jeff King <peff@peff.net>
Date
May 2, 2014, 20:31 UTC
Message-ID
<20140502203116.GA32500@sigill.intra.peff.net>
In-Reply-To
<xmqqk3a4avt1.fsf@gitster.dls.corp.google.com>
On Fri, May 02, 2014 at 11:18:34AM -0700, Junio C Hamano wrote:
Show 19 quoted lines
> Jeff King <peff@peff.net> writes:
> 
> > On Wed, Apr 30, 2014 at 02:45:11PM -0700, Junio C Hamano wrote:
> >
> >> See http://thread.gmane.org/gmane.comp.version-control.git/3903/focus=4126
> >> 
> >> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> >
> > Don't you often complain about submitters referencing a discussion
> > in a commit message without providing some context or summary?
> 
> Yes, but the summary of the discussion would be identical to the new
> text added by the patch to the documentation tree in this case, so I
> didn't find a good introductory text before "See $URL".  Perhaps
> 
>     This comes up from time to time.  See $URL for the original
>     discussion.
> 
> but I do not know if that is much better.

I meant something even less in-depth. Your message says only "on comparison", and I did not even know what "this" in your sentence above would mean until I followed the link.

  There are arguments for writing a conditional as "a < b" rather than
  "b > a", or vice versa. Let's give guidance on which we prefer.

Not a big deal, but I think it is easy when you have just written the patch to forget that a reviewer or a reader of "git log" six months have no has no context at all.

-Peff
Previous: Junio C HamanoNext: Junio C Hamano
Message 26 of 30 in “Update the CodingGuidelines”
  1. 0/8 Update the CodingGuidelinesJunio C Hamano, Apr 30, 2014
  2. 1/8 CodingGuidelines: typofixJunio C Hamano, Apr 30, 2014
  3. David KastrupMay 1, 2014
  4. Junio C HamanoMay 1, 2014
  5. Jeff KingMay 1, 2014
  6. Junio C HamanoMay 2, 2014
  7. Jeff KingMay 2, 2014
  8. Felipe ContrerasMay 2, 2014
  9. David KastrupMay 2, 2014
  10. 2/8 CodingGuidelines: give an example for case/esac statementJunio C Hamano, Apr 30, 2014
  11. 3/8 CodingGuidelines: give an example for redirectionJunio C Hamano, Apr 30, 2014
  12. 3/8 CodingGuidelines: give an example for redirectionJunio C Hamano, Apr 30, 2014
  13. 4/8 CodingGuidelines: give an example for control statementsJunio C Hamano, Apr 30, 2014
  14. Stefan BellerApr 30, 2014
  15. Junio C HamanoApr 30, 2014
  16. David KastrupMay 1, 2014
  17. Junio C HamanoMay 1, 2014
  18. 5/8 CodingGuidelines: give an example for shell function preambleJunio C Hamano, Apr 30, 2014
  19. 6/8 CodingGuidelines: call the conditional statement "if ()", not "if()"Junio C Hamano, Apr 30, 2014
  20. David KastrupMay 1, 2014
  21. Junio C HamanoMay 1, 2014
  22. David KastrupMay 1, 2014
  23. 7/8 CodingGuidelines: on comparisonJunio C Hamano, Apr 30, 2014
  24. Jeff KingMay 1, 2014
  25. Junio C HamanoMay 2, 2014
  26. Jeff KingMay 2, 2014
  27. Junio C HamanoMay 2, 2014
  28. 8/8 CodingGuidelines: once it is in, it is not worth the code churnJunio C Hamano, Apr 30, 2014
  29. 9/8 CodingGuidelines: on splitting a long lineJunio C Hamano, May 2, 2014
  30. brian m. carlsonMay 2, 2014

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.