Skip to contentSkip to conversation

nvme-cli: align comments for struct telemetry_log_page_hdr

PATCH New Akinobu Mita 4 participants 5 messages May 14, 2019 NVMe

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 nvme-cli: align comments for struct telemetry_log_page_hdr

Align the field member comments for struct telemetry_log_page_hdr. This also uses tabs instead of spaces to align field members.

Cc Keith Busch <keith.busch at intel.com>
Cc Chaitanya Kulkarni <Chaitanya.Kulkarni at wdc.com>
Suggested-by Chaitanya Kulkarni <Chaitanya.Kulkarni at wdc.com>
Signed-off-by Akinobu Mita <akinobu.mita at gmail.com>
---
 linux/nvme.h | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)
linux/nvme.h +11 -11
index 2c840b9..118095a 100644
@@ -427,17 +427,17 @@ struct nvme_id_nvmset {
 };
 
 struct nvme_telemetry_log_page_hdr {
-	__u8    lpi; /* Log page identifier */
-	__u8    rsvd[4];
-	__u8    iee_oui[3];
-	__le16  dalb1; /* Data area 1 last block */
-	__le16  dalb2; /* Data area 2 last block */
-	__le16  dalb3; /* Data area 3 last block */
-	__u8    rsvd1[368];
-	__u8    ctrlavail; /* Controller initiated data avail?*/
-	__u8    ctrldgn; /* Controller initiated telemetry Data Gen # */
-	__u8    rsnident[128];
-	__u8    telemetry_dataarea[0];
+	__u8	lpi;		/* Log page identifier */
+	__u8	rsvd[4];
+	__u8	iee_oui[3];
+	__le16	dalb1;		/* Data area 1 last block */
+	__le16	dalb2;		/* Data area 2 last block */
+	__le16	dalb3;		/* Data area 3 last block */
+	__u8	rsvd1[368];
+	__u8	ctrlavail;	/* Controller initiated data avail? */
+	__u8	ctrldgn;	/* Controller initiated telemetry Data Gen # */
+	__u8	rsnident[128];
+	__u8	telemetry_dataarea[0];
 };
 
 struct nvme_endurance_group_log {
Signature · 1 line
2.7.4
#1 lore raw

PATCH 1/1 nvme-cli: align comments for struct telemetry_log_page_hdr

Quoted 2 lines · Akinobu Mita

Align the field member comments for struct telemetry_log_page_hdr. This also uses tabs instead of spaces to align field members.

Hi Akinobu,

Have you considered to use the kernel-doc syntax instead of aligning the comments? See also
https://www.kernel.org/doc/Documentation/kernel-doc-nano-HOWTO.txt.

Thanks,

Bart.

#2 lore raw

PATCH 1/1 nvme-cli: align comments for struct telemetry_log_page_hdr

2019?5?15?(?) 0:22 Bart Van Assche <bvanassche at acm.org>:

Quoted 10 lines · Akinobu Mita
Quoted 2 lines

Align the field member comments for struct telemetry_log_page_hdr. This also uses tabs instead of spaces to align field members.

Hi Akinobu,

Have you considered to use the kernel-doc syntax instead of aligning the comments? See also
https://www.kernel.org/doc/Documentation/kernel-doc-nano-HOWTO.txt.

I personally prefer to use the kernel-doc syntax. So if no one complains, I withdraw this patch and will send a patch to convert kernel-doc syntax.

maintainer
#3 lore raw

PATCH 1/1 nvme-cli: align comments for struct telemetry_log_page_hdr

Quoted 6 lines · Akinobu Mita

2019?5?15?(?) 0:22 Bart Van Assche <bvanassche at acm.org>:

Quoted 5 lines · Akinobu Mita
Quoted 2 lines

Align the field member comments for struct telemetry_log_page_hdr. This also uses tabs instead of spaces to align field members.

Quoted 8 lines
Quoted 5 lines

Hi Akinobu,

Have you considered to use the kernel-doc syntax instead of aligning the comments? See also
https://www.kernel.org/doc/Documentation/kernel-doc-nano-HOWTO.txt.

I personally prefer to use the kernel-doc syntax. So if no one complains, I withdraw this patch and will send a patch to convert kernel-doc syntax.

Me too. Kernel style is preferred. We've just been too lenient on enforcing it, so I would appreciate these style fixes.

#4 lore raw

PATCH 1/1 nvme-cli: align comments for struct telemetry_log_page_hdr

In reply to Akinobu Mita

Looks good to me.

Reviewed-by Chaitanya Kulkarni <chaitanya.kulkarni at wdc.com>
Quoted 45 lines · Akinobu Mita

Align the field member comments for struct telemetry_log_page_hdr. This also uses tabs instead of spaces to align field members.

Cc Keith Busch <keith.busch at intel.com>
Cc Chaitanya Kulkarni <Chaitanya.Kulkarni at wdc.com>
Suggested-by Chaitanya Kulkarni <Chaitanya.Kulkarni at wdc.com>
Signed-off-by Akinobu Mita <akinobu.mita at gmail.com>
---
  linux/nvme.h | 22 +++++++++++-----------
  1 file changed, 11 insertions(+), 11 deletions(-)
linux/nvme.h +11 -11
index 2c840b9..118095a 100644
@@ -427,17 +427,17 @@ struct nvme_id_nvmset {
  };
 
  struct nvme_telemetry_log_page_hdr {
-	__u8    lpi; /* Log page identifier */
-	__u8    rsvd[4];
-	__u8    iee_oui[3];
-	__le16  dalb1; /* Data area 1 last block */
-	__le16  dalb2; /* Data area 2 last block */
-	__le16  dalb3; /* Data area 3 last block */
-	__u8    rsvd1[368];
-	__u8    ctrlavail; /* Controller initiated data avail?*/
-	__u8    ctrldgn; /* Controller initiated telemetry Data Gen # */
-	__u8    rsnident[128];
-	__u8    telemetry_dataarea[0];
+	__u8	lpi;		/* Log page identifier */
+	__u8	rsvd[4];
+	__u8	iee_oui[3];
+	__le16	dalb1;		/* Data area 1 last block */
+	__le16	dalb2;		/* Data area 2 last block */
+	__le16	dalb3;		/* Data area 3 last block */
+	__u8	rsvd1[368];
+	__u8	ctrlavail;	/* Controller initiated data avail? */
+	__u8	ctrldgn;	/* Controller initiated telemetry Data Gen # */
+	__u8	rsnident[128];
+	__u8	telemetry_dataarea[0];
  };
 
  struct nvme_endurance_group_log {