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

Re: [PATCH] document how to reference previous commits

From
Junio C Hamano <gitster@pobox.com>
Date
Jul 28, 2016, 15:38 UTC
Message-ID
<xmqq60rpu61h.fsf@gitster.mtv.corp.google.com>
In-Reply-To
<20160728125514.GA2813@sandbox>
Heiko Voigt <hvoigt@hvoigt.net> writes:
Show 9 quoted lines
> @@ -121,6 +121,11 @@ its behaviour.  Try to make sure your explanation can be understood
>  without external resources. Instead of giving a URL to a mailing list
>  archive, summarize the relevant points of the discussion.
>  
> +If you want to reference a previous commit in the history of a stable
> +branch use the format "abbreviated sha1 (subject, date)". So for example
> +like this: "Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)
> +noticed [...]".
> +

I earlier said that our goal should not be to spell out all the conventions, which would lead to unreadably long document, but this does not look too bad. Small additions however tend to accumulate over time, though ;-)

I wondered if we need to also say "why", but we probably shouldn't.
Thanks.
Previous: Heiko VoigtNext: Stefan Beller
Message 19 of 23 in “submodule-config: use explicit empty string instead of strbuf in config_from()”
  1. submodule-config: use explicit empty string instead of strbuf in config_from()René Scharfe, Jul 19, 2016
  2. Junio C HamanoJul 19, 2016
  3. Stefan BellerJul 19, 2016
  4. Heiko VoigtJul 20, 2016
  5. René ScharfeJul 21, 2016
  6. Heiko VoigtJul 25, 2016
  7. Junio C HamanoJul 25, 2016
  8. 2/2 submodule-config: combine error checking if clausesHeiko Voigt, Jul 26, 2016
  9. Stefan BellerJul 26, 2016
  10. 1/2 fix passing a name for config from submodulesHeiko Voigt, Jul 26, 2016
  11. Stefan BellerJul 26, 2016
  12. Junio C HamanoJul 26, 2016
  13. 1/3 submodule-config: passing name reference for .gitmodule blobsHeiko Voigt, Jul 28, 2016
  14. Stefan BellerJul 28, 2016
  15. 2/3 submodule-config: combine early return code into one gotoHeiko Voigt, Jul 28, 2016
  16. 3/3 submodule-config: fix test binary crashing when no arguments givenHeiko Voigt, Jul 28, 2016
  17. Heiko VoigtJul 28, 2016
  18. document how to reference previous commitsHeiko Voigt, Jul 28, 2016
  19. Junio C HamanoJul 28, 2016
  20. Stefan BellerJul 28, 2016
  21. Heiko VoigtAug 17, 2016
  22. Junio C HamanoAug 17, 2016
  23. Junio C HamanoJul 28, 2016

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.