From: Kari Argillander <kari.argillander@gmail.com>
To: Dan Carpenter <dan.carpenter@oracle.com>
Cc: Konstantin Komarov <almaz.alexandrovich@paragon-software.com>,
linux-fsdevel@vger.kernel.org, viro@zeniv.linux.org.uk,
linux-kernel@vger.kernel.org, pali@kernel.org, dsterba@suse.cz,
aaptel@suse.com, willy@infradead.org, rdunlap@infradead.org,
joe@perches.com, mark@harmstone.com, nborisov@suse.com,
linux-ntfs-dev@lists.sourceforge.net, anton@tuxera.com,
hch@lst.de, ebiggers@kernel.org, andy.lavr@gmail.com,
oleksandr@natalenko.name
Subject: Re: [PATCH] Restyle comments to better align with kernel-doc
Date: Tue, 3 Aug 2021 18:26:19 +0300 [thread overview]
Message-ID: <20210803152619.hva737erzqnksfxu@kari-VirtualBox> (raw)
In-Reply-To: <20210803133833.GL25548@kadam>
On Tue, Aug 03, 2021 at 04:38:33PM +0300, Dan Carpenter wrote:
> Missing subsystem prefix in the subject.
Yeah. I was not sure what to do here because it is patch to patch. I
will do this in the future.
> On Tue, Aug 03, 2021 at 02:57:09PM +0300, Kari Argillander wrote:
> > Capitalize comments and end with period for better reading.
> >
> > Also function comments are now little more kernel-doc style. This way we
> > can easily convert them to kernel-doc style if we want. Note that these
> > are not yet complete with this style. Example function comments start
> > with /* and in kernel-doc style they start /**.
> >
> > Use imperative mood in function descriptions.
> >
> > Change words like ntfs -> NTFS, linux -> Linux.
> >
> > Use "we" not "I" when commenting code.
>
> These are all nonsense style guidelines that you invented yourself. We
> already have too much pointless bureaucracy. If you can't understand
> the documentation or if there are typos then, sure, fix that. But let's
> not invent new rules.
You are correct that I "invent" these. My whole point was just make
ntfs3 constant about these rules. I also notice that I didn't make that
clear at patch message and that was huge mistake from my part.
Now in ntfs3 there is mixing commenting styles and I was just trying to make
these nice before merging. I have no preference but it is nice if example one
driver keep things constant.
I would not even try to make these kind of changes if ntfs3 patch series
was already merged to kernel. But probably I will try to bring kernel doc
style funtion comments in future when ntfs3 gets merged.
> (Also it annoys me when people pretend to be stupid "I can't understand
> what a NULL deference is. Ohhh... You mean a NULL *pointer*
> dereference! You left out the word *pointer* so I didn't understand!")
next prev parent reply other threads:[~2021-08-03 15:26 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-29 13:49 [PATCH v27 00/10] NTFS read-write driver GPL implementation by Paragon Software Konstantin Komarov
2021-07-29 13:49 ` [PATCH v27 01/10] fs/ntfs3: Add headers and misc files Konstantin Komarov
2021-07-29 13:49 ` [PATCH v27 02/10] fs/ntfs3: Add initialization of super block Konstantin Komarov
2021-07-29 15:59 ` Matthew Wilcox
2021-07-30 8:28 ` Christophe JAILLET
2021-08-10 9:02 ` Christoph Hellwig
2021-07-29 13:49 ` [PATCH v27 03/10] fs/ntfs3: Add bitmap Konstantin Komarov
2021-07-30 8:11 ` Christophe JAILLET
2021-07-29 13:49 ` [PATCH v27 04/10] fs/ntfs3: Add file operations and implementation Konstantin Komarov
2021-07-30 7:40 ` Christophe JAILLET
2021-08-22 12:20 ` Pali Rohár
2021-08-22 14:31 ` Kari Argillander
2021-08-24 11:33 ` Pali Rohár
2021-07-29 13:49 ` [PATCH v27 05/10] fs/ntfs3: Add attrib operations Konstantin Komarov
2021-07-30 7:30 ` Christophe JAILLET
2021-07-29 13:49 ` [PATCH v27 06/10] fs/ntfs3: Add compression Konstantin Komarov
2021-07-29 13:49 ` [PATCH v27 07/10] fs/ntfs3: Add NTFS journal Konstantin Komarov
2021-07-30 8:06 ` Christophe JAILLET
2021-07-29 13:49 ` [PATCH v27 08/10] fs/ntfs3: Add Kconfig, Makefile and doc Konstantin Komarov
2021-08-10 7:47 ` Kari Argillander
2021-08-10 8:19 ` Pali Rohár
2021-08-10 8:46 ` Kari Argillander
2021-07-29 13:49 ` [PATCH v27 09/10] fs/ntfs3: Add NTFS3 in fs/Kconfig and fs/Makefile Konstantin Komarov
2021-07-29 13:49 ` [PATCH v27 10/10] fs/ntfs3: Add MAINTAINERS Konstantin Komarov
2021-08-09 10:56 ` David Sterba
2021-08-09 16:16 ` Konstantin Komarov
2021-08-09 16:44 ` Kari Argillander
2021-08-09 16:54 ` Randy Dunlap
2021-08-09 18:56 ` Dan Williams
2021-08-09 19:45 ` Kari Argillander
2021-07-29 16:24 ` [PATCH v27 00/10] NTFS read-write driver GPL implementation by Paragon Software Darrick J. Wong
2021-08-02 3:23 ` Theodore Ts'o
2021-08-02 15:05 ` Theodore Ts'o
2021-08-12 17:03 ` Kari Argillander
2021-08-13 15:53 ` Kari Argillander
2021-08-21 12:38 ` Yan Pashkovsky
2021-08-03 11:57 ` [PATCH] Restyle comments to better align with kernel-doc Kari Argillander
2021-08-03 13:38 ` Dan Carpenter
2021-08-03 15:26 ` Kari Argillander [this message]
2021-08-03 15:41 ` Matthew Wilcox
2021-08-30 16:10 ` Konstantin Komarov
2021-08-30 17:13 ` Kari Argillander
2021-08-10 5:46 ` [PATCH v27 00/10] NTFS read-write driver GPL implementation by Paragon Software Kari Argillander
2021-08-10 6:47 ` Darrick J. Wong
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=20210803152619.hva737erzqnksfxu@kari-VirtualBox \
--to=kari.argillander@gmail.com \
--cc=aaptel@suse.com \
--cc=almaz.alexandrovich@paragon-software.com \
--cc=andy.lavr@gmail.com \
--cc=anton@tuxera.com \
--cc=dan.carpenter@oracle.com \
--cc=dsterba@suse.cz \
--cc=ebiggers@kernel.org \
--cc=hch@lst.de \
--cc=joe@perches.com \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-ntfs-dev@lists.sourceforge.net \
--cc=mark@harmstone.com \
--cc=nborisov@suse.com \
--cc=oleksandr@natalenko.name \
--cc=pali@kernel.org \
--cc=rdunlap@infradead.org \
--cc=viro@zeniv.linux.org.uk \
--cc=willy@infradead.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 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.