All of lore.kernel.org
 help / color / mirror / Atom feed
From: Dan Carpenter <dan.carpenter@oracle.com>
To: Elena Afanasova <eafanasova@gmail.com>
Cc: gregkh@linuxfoundation.org, devel@driverdev.osuosl.org,
	outreachy-kernel@googlegroups.com
Subject: Re: [PATCH] staging/rtl8192u/ieee80211: fix line length exceeds 100 columns
Date: Tue, 27 Oct 2020 14:37:02 +0300	[thread overview]
Message-ID: <20201027113702.GU1042@kadam> (raw)
In-Reply-To: <20201020151111.35848-1-eafanasova@gmail.com>

On Tue, Oct 20, 2020 at 08:11:11AM -0700, Elena Afanasova wrote:
> Reported by checkpatch.pl.

The commit message should be considered like an separate thing from the
subject.  On my email client, I normally read either just the subject or
just the commit message.  It looks something like this:

https://lore.kernel.org/driverdev-devel/20201020151748.35937-1-eafanasova@gmail.com/T/#t

Do you see the subject?  It's far away from the commit message.

Here is how I would write this commit message:

Subject: [PATCH] Staging: rtl8192u: split up long lines

Checkpatch complains that these lines are over 100 characters so let's
split them up.

Some people care about verb tenses or whatever but most maintainers
don't.  I don't.  I only care about if I can basically see what you
are changing and why.  This patch doesn't affect runtime, but if it
did, then I would like some comments about what the bug looks like to
the user.  Basically if I can understand the commit message then it's
fine, and obviously "Reported by checkpatch.pl" is not sufficient to
understand what's going on.

regards,
dan carpenter



      reply	other threads:[~2020-10-27 11:37 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-20 15:11 [PATCH] staging/rtl8192u/ieee80211: fix line length exceeds 100 columns Elena Afanasova
2020-10-27 11:37 ` Dan Carpenter [this message]

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=20201027113702.GU1042@kadam \
    --to=dan.carpenter@oracle.com \
    --cc=devel@driverdev.osuosl.org \
    --cc=eafanasova@gmail.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=outreachy-kernel@googlegroups.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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.