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

[PATCH v3 0/3] contributor doc update around log messages

From
Junio C Hamano <gitster@pobox.com>
Date
Jan 27, 2022, 19:02 UTC
Message-ID
<20220127190259.2470753-1-gitster@pobox.com>
In-Reply-To
<20220126234205.2923388-1-gitster@pobox.com>

We already explain _how_ to write log messages, but did not tell readers why we care. Add a few paragraphs to SubmittingPatches and CodingGuidelines to do so.

Junio C Hamano (3):
  SubmittingPatches: write problem statement in the log in the present
    tense
  CodingGuidelines: hint why we value clearly written log messages
  SubmittingPatches: explain why we care about log messages
 Documentation/CodingGuidelines  |  7 +++++++
 Documentation/SubmittingPatches | 36 +++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+)
Range-diff against v2:
-:  ---------- > 1:  b86a706bfd SubmittingPatches: write problem statement in the log in the present tense
1:  35e39deb7d ! 2:  a65df87939 CodingGuidelines: hint why we value clearly written log messages
    @@ Documentation/CodingGuidelines: code.  For Git in general, a few rough rules are
         go and fix it up."
         Cf. http://lkml.iu.edu/hypermail/linux/kernel/1001.3/01069.html
      
    -+ - Log messages to explain your changes are as much important as the
    ++ - Log messages to explain your changes are as important as the
     +   changes themselves.  Clearly written code and in-code comments
     +   explain how the code works and what is assumed from the surrounding
     +   context.  The log messages explain what the changes wanted to
2:  fb54bcfcda < -:  ---------- SubmittingPatches: explain why we care about log messages
-:  ---------- > 3:  77d918fb98 SubmittingPatches: explain why we care about log messages
-- 
2.35.0-177-g7d269f5170
Previous: Junio C HamanoNext: Emily Shaffer
Message 10 of 28 in “[RFC] Contributor doc: more on the proposed log message”
  1. Junio C HamanoJan 23, 2022
  2. brian m. carlsonJan 23, 2022
  3. Kaartic SivaraamJan 26, 2022
  4. 0/3 contributor doc update around log messagesJunio C Hamano, Jan 26, 2022
  5. 1/3 SubmittingPatches: write problem statement in the log in the present tenseJunio C Hamano, Jan 26, 2022
  6. 2/3 CodingGuidelines: hint why we value clearly written log messagesJunio C Hamano, Jan 26, 2022
  7. Eric SunshineJan 27, 2022
  8. Junio C HamanoJan 27, 2022
  9. 3/3 SubmittingPatches: explain why we care about log messagesJunio C Hamano, Jan 26, 2022
  10. 0/3 contributor doc update around log messagesJunio C Hamano, Jan 27, 2022
  11. Emily ShafferMar 4, 2022
  12. 1/3 SubmittingPatches: write problem statement in the log in the present tenseJunio C Hamano, Jan 27, 2022
  13. Emily ShafferMar 3, 2022
  14. Junio C HamanoMar 4, 2022
  15. Emily ShafferMar 4, 2022
  16. 2/3 CodingGuidelines: hint why we value clearly written log messagesJunio C Hamano, Jan 27, 2022
  17. Emily ShafferMar 4, 2022
  18. Junio C HamanoMar 4, 2022
  19. Junio C HamanoApr 14, 2022
  20. Ævar Arnfjörð BjarmasonApr 14, 2022
  21. Emily ShafferApr 19, 2022
  22. Junio C HamanoApr 20, 2022
  23. 3/3 SubmittingPatches: explain why we care about log messagesJunio C Hamano, Jan 27, 2022
  24. Emily ShafferMar 4, 2022
  25. Junio C HamanoMar 4, 2022
  26. log messages > comments (was: [PATCH v3 3/3] SubmittingPatches: explain why we care about log messages)Ævar Arnfjörð Bjarmason, Mar 4, 2022
  27. Junio C HamanoMar 4, 2022
  28. Junio C HamanoMar 4, 2022

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.