Documentation/filesystems/bcachefs/CodingStyle.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
---
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.
--
2.46.0
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
On Wed, Sep 11, 2024 at 4:03 PM Carlos Bilbao <carlos.bilbao.osdev@gmail.com> wrote: > > 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 > Thanks for the response, I'll be sure to send a new better formatted patch. Dennis
On 9/11/24 19:17, Dennis Lam wrote: > On Wed, Sep 11, 2024 at 4:03 PM Carlos Bilbao > <carlos.bilbao.osdev@gmail.com> wrote: >> 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 >> > Thanks for the response, I'll be sure to send a new better formatted patch. Awesome! Feel free to CC me :) > > Dennis Thanks, Carlos
© 2016 - 2024 Red Hat, Inc.