From: Konstantin Komarov <almaz.alexandrovich@paragon-software.com>
To: Kari Argillander <kari.argillander@gmail.com>
Cc: <linux-fsdevel@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
<joe@perches.com>, <dan.carpenter@oracle.com>,
<willy@infradead.org>, <ntfs3@lists.linux.dev>
Subject: Re: [PATCH] Restyle comments to better align with kernel-doc
Date: Mon, 30 Aug 2021 19:10:36 +0300 [thread overview]
Message-ID: <22f979ec-95e5-e95a-0d58-9eb43f2038aa@paragon-software.com> (raw)
In-Reply-To: <20210803115709.zd3gjmxw7oe6b4zk@kari-VirtualBox>
On 03.08.2021 14:57, 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.
>
> Signed-off-by: Kari Argillander <kari.argillander@gmail.com>
> ---
> Yes I know that this patch is quite monster. That's why I try to send this
> now before patch series get merged. After that this patch probebly needs to
> be splitted more and sended in patch series.
>
> If someone thinks this should not be added now it is ok. I have try to read
> what is kernel philosophy in case "patch to patch" but haven't found any
> good information about it. It is no big deal to add later. In my own mind I
> do not want to touch so much comments after code is in.
>
> I also don't know how easy this kind of patch is apply top of the patch
> series.
Thanks for the patch. I've applied it to create uniform style of comments.
Also removed double line addition from patch:
@@ -269,22 +260,28 @@ enum RECORD_FLAG {
RECORD_FLAG_UNKNOWN = cpu_to_le16(0x0008),
};
-/* MFT Record structure */
+/* MFT Record structure, */
struct MFT_REC {
struct NTFS_RECORD_HEADER rhdr; // 'FILE'
- __le16 seq; // 0x10: Sequence number for this record
- __le16 hard_links; // 0x12: The number of hard links to record
- __le16 attr_off; // 0x14: Offset to attributes
- __le16 flags; // 0x16: See RECORD_FLAG
- __le32 used; // 0x18: The size of used part
- __le32 total; // 0x1C: Total record size
+ __le16 seq; // 0x10: Sequence number for this record.
+ __le16 hard_links; // 0x12: The number of hard links to record.
+ __le16 attr_off; // 0x14: Offset to attributes.
+ __le16 flags; // 0x16: See RECORD_FLAG.
+ __le32 used; // 0x18: The size of used part.
+ __le32 total; // 0x1C: Total record size.
+
+ struct MFT_REF parent_ref; // 0x20: Parent MFT record.
+ __le16 next_attr_id; // 0x28: The next attribute Id.
- struct MFT_REF parent_ref; // 0x20: Parent MFT record
- __le16 next_attr_id; // 0x28: The next attribute Id
+ __le32 used; // 0x18: The size of used part.
+ __le32 total; // 0x1C: Total record size.
- __le16 res; // 0x2A: High part of mft record?
- __le32 mft_record; // 0x2C: Current mft record number
+ struct MFT_REF parent_ref; // 0x20: Parent MFT record.
+ __le16 next_attr_id; // 0x28: The next attribute Id.
+
+ __le16 res; // 0x2A: High part of MFT record?
+ __le32 mft_record; // 0x2C: Current MFT record number.
__le16 fixups[]; // 0x30:
};
next prev parent reply other threads:[~2021-08-30 16:10 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20210729134943.778917-1-almaz.alexandrovich@paragon-software.com>
[not found] ` <20210729162459.GA3601405@magnolia>
[not found] ` <YQdlJM6ngxPoeq4U@mit.edu>
[not found] ` <20210812170326.6szm7us5kfdte52u@kari-VirtualBox>
2021-08-13 15:53 ` [PATCH v27 00/10] NTFS read-write driver GPL implementation by Paragon Software Kari Argillander
[not found] ` <20210803115709.zd3gjmxw7oe6b4zk@kari-VirtualBox>
2021-08-30 16:10 ` Konstantin Komarov [this message]
2021-08-30 17:13 ` [PATCH] Restyle comments to better align with kernel-doc Kari Argillander
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=22f979ec-95e5-e95a-0d58-9eb43f2038aa@paragon-software.com \
--to=almaz.alexandrovich@paragon-software.com \
--cc=dan.carpenter@oracle.com \
--cc=joe@perches.com \
--cc=kari.argillander@gmail.com \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=ntfs3@lists.linux.dev \
--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 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).