mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Carlos Bilbao <carlos.bilbao.osdev@gmail.com>
To: Dennis Lam <dennis.lamerice@gmail.com>,
	kent.overstreet@linux.dev, corbet@lwn.net
Cc: linux-bcachefs@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs:fs:fixed some spelling mistakes in the bcachefs coding style page
Date: Wed, 11 Sep 2024 15:03:03 -0500	[thread overview]
Message-ID: <200ce66b-845f-4f20-8838-619646f5f44d@gmail.com> (raw)
In-Reply-To: <20240906195720.40315-1-dennis.lamerice@gmail.com>

Hello,

On 9/6/24 14:57, Dennis Lam wrote:
> ---


Change the subject, it needs spaces to be readable:

"docs: fs: fixed spelling mistakes [...]"

Also, you need a body in the commit which includes an explanation of what
the patch does (even if it is almost the same as the Subject) and your
signature. See: https://docs.kernel.org/process/submitting-patches.html


>  Documentation/filesystems/bcachefs/CodingStyle.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/filesystems/bcachefs/CodingStyle.rst b/Documentation/filesystems/bcachefs/CodingStyle.rst
> index 0c45829a4899..b29562a6bf55 100644
> --- a/Documentation/filesystems/bcachefs/CodingStyle.rst
> +++ b/Documentation/filesystems/bcachefs/CodingStyle.rst
> @@ -175,7 +175,7 @@ errors in our thinking by running our code and seeing what happens. If your
>  time is being wasted because your tools are bad or too slow - don't accept it,
>  fix it.
>  
> -Put effort into your documentation, commmit messages, and code comments - but
> +Put effort into your documentation, commit messages, and code comments - but
>  don't go overboard. A good commit message is wonderful - but if the information
>  was important enough to go in a commit message, ask yourself if it would be
>  even better as a code comment.
> @@ -183,4 +183,4 @@ even better as a code comment.
>  A good code comment is wonderful, but even better is the comment that didn't
>  need to exist because the code was so straightforward as to be obvious;
>  organized into small clean and tidy modules, with clear and descriptive names
> -for functions and variable, where every line of code has a clear purpose.
> +for functions and variables, where every line of code has a clear purpose.


Thanks, Carlos


  reply	other threads:[~2024-09-11 20:03 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-06 19:57 Dennis Lam
2024-09-11 20:03 ` Carlos Bilbao [this message]
2024-09-12  0:17   ` Dennis Lam
2024-09-13 15:39     ` Carlos Bilbao

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=200ce66b-845f-4f20-8838-619646f5f44d@gmail.com \
    --to=carlos.bilbao.osdev@gmail.com \
    --cc=corbet@lwn.net \
    --cc=dennis.lamerice@gmail.com \
    --cc=kent.overstreet@linux.dev \
    --cc=linux-bcachefs@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@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

all inboxes | Powered by JetHome®