git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] SubmittingPatches: Cite the 50 char subject limit
Date: Wed, 28 Jul 2010 10:23:24 -0700	[thread overview]
Message-ID: <7vzkxb4j1v.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: 1280326285-10203-1-git-send-email-avarab@gmail.com

Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:

> Change the SubmittingPatches recommendations to mention the 50
> character soft limit on patch subject lines. 50 characters is the soft
> limit mentioned in git-commit(1) and gittutorial(7), it's also the
> point at which Gitweb, GitHub and various other Git front ends start
> abbreviating the commit message.

Hmph, we probably would want to do s/50 character/&s/ in the two manual
pages.  I do not think if anybody is ready to stand behind the specific
number "50", and we can bikeshed about it separately.

The spirit of having a soft limit is twofold:

 - It should fit on "git log --oneline" comfortably;

 - If your change is too complex to be summarized in such a short
   sentence, you probably are doing too many things in one commit.

The first does not justify "50" any better than other arbitrary limit, but
with things like --graph and --source, anything longer makes the resulting
output very close to the edge of an 80-column terminal.

The second does not justify "50" either, as your language may be verbose
or terse (e.g. Japanese can cram far more information in a 140-char tweet
than somebody writing in English), but it is a more important one between
the two rationales above.

  reply	other threads:[~2010-07-28 17:23 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-07-28 14:11 [PATCH] SubmittingPatches: Cite the 50 char subject limit Ævar Arnfjörð Bjarmason
2010-07-28 17:23 ` Junio C Hamano [this message]
2010-07-28 19:25   ` Ævar Arnfjörð Bjarmason
2010-07-28 19:49     ` Joshua Juran
2010-07-28 20:15       ` Ævar Arnfjörð Bjarmason
2010-07-28 20:32         ` Joshua Juran

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7vzkxb4j1v.fsf@alter.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    /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.
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 NNTP newsgroup(s).