From: Junio C Hamano <gitster@pobox.com>
To: Heiko Voigt <hvoigt@hvoigt.net>
Cc: "Stefan Beller" <sbeller@google.com>,
"Git List" <git@vger.kernel.org>,
"Lars Schneider" <larsxschneider@gmail.com>,
"René Scharfe" <l.s.r@web.de>
Subject: Re: [PATCH] document how to reference previous commits
Date: Thu, 28 Jul 2016 08:38:18 -0700 [thread overview]
Message-ID: <xmqq60rpu61h.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20160728125514.GA2813@sandbox> (Heiko Voigt's message of "Thu, 28 Jul 2016 14:55:14 +0200")
Heiko Voigt <hvoigt@hvoigt.net> writes:
> @@ -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.
next prev parent reply other threads:[~2016-07-28 15:38 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-19 19:05 [PATCH] submodule-config: use explicit empty string instead of strbuf in config_from() René Scharfe
2016-07-19 19:15 ` Junio C Hamano
2016-07-19 19:24 ` Stefan Beller
2016-07-20 8:25 ` Heiko Voigt
2016-07-21 18:57 ` René Scharfe
2016-07-25 14:37 ` Heiko Voigt
2016-07-25 14:58 ` Junio C Hamano
2016-07-26 9:49 ` [PATCH 1/2] fix passing a name for config from submodules Heiko Voigt
2016-07-26 17:22 ` Stefan Beller
2016-07-26 22:02 ` Junio C Hamano
2016-07-28 12:49 ` [PATCH 1/3] submodule-config: passing name reference for .gitmodule blobs Heiko Voigt
2016-07-28 16:26 ` Stefan Beller
2016-07-28 12:49 ` [PATCH 2/3] submodule-config: combine early return code into one goto Heiko Voigt
2016-07-28 12:50 ` [PATCH 3/3] submodule-config: fix test binary crashing when no arguments given Heiko Voigt
2016-07-28 11:17 ` [PATCH 1/2] fix passing a name for config from submodules Heiko Voigt
2016-07-28 12:55 ` [PATCH] document how to reference previous commits Heiko Voigt
2016-07-28 15:38 ` Junio C Hamano [this message]
2016-07-28 15:57 ` Stefan Beller
2016-08-17 11:36 ` Heiko Voigt
2016-08-17 17:45 ` Junio C Hamano
2016-07-28 14:59 ` [PATCH 1/2] fix passing a name for config from submodules Junio C Hamano
2016-07-26 9:49 ` [PATCH 2/2] submodule-config: combine error checking if clauses Heiko Voigt
2016-07-26 17:24 ` Stefan Beller
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq60rpu61h.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=hvoigt@hvoigt.net \
--cc=l.s.r@web.de \
--cc=larsxschneider@gmail.com \
--cc=sbeller@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).