Skip to contentSkip to conversation

Fixed styling in riscv ucontext header

PATCH Superseded Cleo John 2 participants 5 messages Oct 9, 2022 RISC-V

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Cleo John

author
#0 lore raw

PATCH 1/1 Fixed styling in riscv ucontext header

This patch changes the two comments in ucontext.h by getting them up to the cody style proposed by torwalds. In my opinion this also improves the readability so I think this is a useful change to do. Please also tell me if you have a different opinion.

---
 arch/riscv/include/uapi/asm/ucontext.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
arch/riscv/include/uapi/asm/ucontext.h +4 -2
index 44eb993950e5..0cd6f8616985 100644
@@ -18,7 +18,8 @@ struct ucontext {
 	/* There's some padding here to allow sigset_t to be expanded in the
 	 * future.  Though this is unlikely, other architectures put uc_sigmask
 	 * at the end of this structure and explicitly state it can be
-	 * expanded, so we didn't want to box ourselves in here. */
+	 * expanded, so we didn't want to box ourselves in here.
+	 */
 	__u8		  __unused[1024 / 8 - sizeof(sigset_t)];
 	/* We can't put uc_sigmask at the end of this structure because we need
 	 * to be able to expand sigcontext in the future.  For example, the
@@ -27,7 +28,8 @@ struct ucontext {
 	 * ucontext, so we're putting this at the end in order to allow for
 	 * infinite extensibility.  Since we know this will be extended and we
 	 * assume sigset_t won't be extended an extreme amount, we're
-	 * prioritizing this. */
+	 * prioritizing this.
+	 */
 	struct sigcontext uc_mcontext;
 };
 
Signature · 7 lines
2.25.1


_______________________________________________
linux-riscv mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-riscv
#1 lore raw

Hey Cleo,

Quoted 1 line · Cleo John

Fixed styling in riscv ucontext header

This should probably be "riscv: fix styling..."

Quoted 1 line

This patch changes the two comments in ucontext.h by getting them up to the cody style proposed by torwalds.

s/This patch changes/Change

Looks like some typos here too & your lines need to be wrapped at 72 characters for commit messages. git usually enforces that automatically when you do a git commit.

Quoted 2 lines

In my opinion this also improves the readability so I think this is a useful change to do. Please also tell me if you have a different opinion.

FYI commentary on the patch should go below the ---.

arch/riscv/include/uapi/asm/ucontext.h struct ucontext { · line 18

Quoted 12 lines
---
 arch/riscv/include/uapi/asm/ucontext.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
arch/riscv/include/uapi/asm/ucontext.h +0 -0
index 44eb993950e5..0cd6f8616985 100644
@@ -18,7 +18,8 @@ struct ucontext {
 	/* There's some padding here to allow sigset_t to be expanded in the

Why fix the closing comment but leave the opening ones incorrect?

Thanks,
Conor.

Quoted 26 lines
arch/riscv/include/uapi/asm/ucontext.h +4 -2
 	 * future.  Though this is unlikely, other architectures put uc_sigmask
 	 * at the end of this structure and explicitly state it can be
-	 * expanded, so we didn't want to box ourselves in here. */
+	 * expanded, so we didn't want to box ourselves in here.
+	 */
 	__u8		  __unused[1024 / 8 - sizeof(sigset_t)];
 	/* We can't put uc_sigmask at the end of this structure because we need
 	 * to be able to expand sigcontext in the future.  For example, the
@@ -27,7 +28,8 @@ struct ucontext {
 	 * ucontext, so we're putting this at the end in order to allow for
 	 * infinite extensibility.  Since we know this will be extended and we
 	 * assume sigset_t won't be extended an extreme amount, we're
-	 * prioritizing this. */
+	 * prioritizing this.
+	 */
 	struct sigcontext uc_mcontext;
 };
 
Signature · 7 lines
2.25.1


_______________________________________________
linux-riscv mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-riscv
author
#2 lore raw

Hey Connor,

Quoted 6 lines · Conor Dooley

Hey Cleo,

Quoted 1 line · Cleo John

Fixed styling in riscv ucontext header

This should probably be "riscv: fix styling..."

okay yea, I will change this in a second patch.

Quoted 7 lines
Quoted 2 lines

This patch changes the two comments in ucontext.h by getting them up to the cody style proposed by torwalds.

s/This patch changes/Change

Looks like some typos here too & your lines need to be wrapped at 72 characters for commit messages. git usually enforces that automatically when you do a git commit.

I will wrap the lines, but where are the typos if I may ask?

Quoted 4 lines
Quoted 2 lines

In my opinion this also improves the readability so I think this is a useful change to do. Please also tell me if you have a different opinion.

FYI commentary on the patch should go below the ---.

will note

Quoted 6 lines
Quoted 6 lines

---

 arch/riscv/include/uapi/asm/ucontext.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
Quoted 8 lines

arch/riscv/include/uapi/asm/ucontext.h struct ucontext { · line 19

Quoted 8 lines
(quoted diff) +0 -0

b/arch/riscv/include/uapi/asm/ucontext.h index 44eb993950e5..0cd6f8616985 100644

arch/riscv/include/uapi/asm/ucontext.h +0 -0
@@ -18,7 +18,8 @@ struct ucontext {
 
 	/* There's some padding here to allow sigset_t to be expanded in 

the

Quoted 5 lines

Why fix the closing comment but leave the opening ones incorrect?

Thanks,
Conor.

I mixed the code style up with the one in net/ -will fix

Thanks,
Cleo.

Quoted 1 line

arch/riscv/include/uapi/asm/ucontext.h struct ucontext { · line 20

Quoted 1 line
arch/riscv/include/uapi/asm/ucontext.h +0 -0
 	 * future.  Though this is unlikely, other architectures put 

uc_sigmask

Quoted 8 lines

arch/riscv/include/uapi/asm/ucontext.h

Quoted 8 lines
arch/riscv/include/uapi/asm/ucontext.h +2 -1
 	 * at the end of this structure and explicitly state it can be
 
-	 * expanded, so we didn't want to box ourselves in here. */
+	 * expanded, so we didn't want to box ourselves in here.
+	 */
 
arch/riscv/include/uapi/asm/ucontext.h +0 -0
 	__u8		  __unused[1024 / 8 - sizeof(sigset_t)];
 	/* We can't put uc_sigmask at the end of this structure because we 

need

Quoted 2 lines
Quoted 2 lines

* to be able to expand sigcontext in the future. For example,

the

Quoted 4 lines

arch/riscv/include/uapi/asm/ucontext.h struct ucontext { · line 29

Quoted 4 lines
arch/riscv/include/uapi/asm/ucontext.h +0 -0
@@ -27,7 +28,8 @@ struct ucontext {
 
 	 * ucontext, so we're putting this at the end in order to allow 

for

Quoted 1 line

arch/riscv/include/uapi/asm/ucontext.h struct ucontext { · line 30

Quoted 1 line
arch/riscv/include/uapi/asm/ucontext.h +0 -0
 	 * infinite extensibility.  Since we know this will be extended and 

we

Quoted 9 lines
Quoted 9 lines
arch/riscv/include/uapi/asm/ucontext.h +2 -1
 	 * assume sigset_t won't be extended an extreme amount, we're
 
-	 * prioritizing this. */
+	 * prioritizing this.
+	 */
 

struct sigcontext uc_mcontext;

};

#3 lore raw
Quoted 12 lines · Cleo John

Hey Connor,

Quoted 6 lines · Conor Dooley

Hey Cleo,

Quoted 1 line · Cleo John

Fixed styling in riscv ucontext header

This should probably be "riscv: fix styling..."

okay yea, I will change this in a second patch.

Quoted 9 lines
Quoted 7 lines
Quoted 2 lines

This patch changes the two comments in ucontext.h by getting them up to the cody style proposed by torwalds.

s/This patch changes/Change

Looks like some typos here too & your lines need to be wrapped at 72 characters for commit messages. git usually enforces that automatically when you do a git commit.

I will wrap the lines, but where are the typos if I may ask?

"cody style" & s/w/v/ in Linus' name.

Quoted 63 lines
Quoted 4 lines
Quoted 2 lines

In my opinion this also improves the readability so I think this is a useful change to do. Please also tell me if you have a different opinion.

FYI commentary on the patch should go below the ---.

will note

Quoted 6 lines
Quoted 6 lines

---

 arch/riscv/include/uapi/asm/ucontext.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
Quoted 8 lines

arch/riscv/include/uapi/asm/ucontext.h struct ucontext { · line 19

Quoted 8 lines
(quoted diff) +0 -0

b/arch/riscv/include/uapi/asm/ucontext.h index 44eb993950e5..0cd6f8616985 100644

arch/riscv/include/uapi/asm/ucontext.h +0 -0
@@ -18,7 +18,8 @@ struct ucontext {
 
 	/* There's some padding here to allow sigset_t to be expanded in 

the

Quoted 5 lines

Why fix the closing comment but leave the opening ones incorrect?

Thanks,
Conor.

I mixed the code style up with the one in net/ -will fix

Thanks,
Cleo.

Quoted 1 line

arch/riscv/include/uapi/asm/ucontext.h struct ucontext { · line 20

Quoted 1 line
arch/riscv/include/uapi/asm/ucontext.h +0 -0
 	 * future.  Though this is unlikely, other architectures put 

uc_sigmask

Quoted 8 lines

arch/riscv/include/uapi/asm/ucontext.h

Quoted 8 lines
arch/riscv/include/uapi/asm/ucontext.h +2 -1
 	 * at the end of this structure and explicitly state it can be
 
-	 * expanded, so we didn't want to box ourselves in here. */
+	 * expanded, so we didn't want to box ourselves in here.
+	 */
 
arch/riscv/include/uapi/asm/ucontext.h +0 -0
 	__u8		  __unused[1024 / 8 - sizeof(sigset_t)];
 	/* We can't put uc_sigmask at the end of this structure because we 

need

Quoted 2 lines
Quoted 2 lines

* to be able to expand sigcontext in the future. For example,

the

Quoted 4 lines

arch/riscv/include/uapi/asm/ucontext.h struct ucontext { · line 29

Quoted 4 lines
arch/riscv/include/uapi/asm/ucontext.h +0 -0
@@ -27,7 +28,8 @@ struct ucontext {
 
 	 * ucontext, so we're putting this at the end in order to allow 

for

Quoted 1 line

arch/riscv/include/uapi/asm/ucontext.h struct ucontext { · line 30

Quoted 1 line
arch/riscv/include/uapi/asm/ucontext.h +0 -0
 	 * infinite extensibility.  Since we know this will be extended and 

we

Quoted 9 lines
Quoted 9 lines
arch/riscv/include/uapi/asm/ucontext.h +2 -1
 	 * assume sigset_t won't be extended an extreme amount, we're
 
-	 * prioritizing this. */
+	 * prioritizing this.
+	 */
 

struct sigcontext uc_mcontext;

};

author
#4 lore raw
Quoted 19 lines · Conor Dooley
Quoted 18 lines · Cleo John

Hey Connor,

Quoted 6 lines · Conor Dooley

Hey Cleo,

Quoted 1 line · Cleo John

Fixed styling in riscv ucontext header

This should probably be "riscv: fix styling..."

okay yea, I will change this in a second patch.

Quoted 6 lines
Quoted 3 lines

This patch changes the two comments in ucontext.h by getting them up to
the cody style proposed by torwalds.

s/This patch changes/Change

Quoted 8 lines
Quoted 5 lines
Quoted 3 lines

Looks like some typos here too & your lines need to be wrapped at 72 characters for commit messages. git usually enforces that automatically when you do a git commit.

I will wrap the lines, but where are the typos if I may ask?

"cody style" & s/w/v/ in Linus' name.

okay, this is.. embarrassing.

Quoted 57 lines
Quoted 57 lines
Quoted 5 lines
Quoted 3 lines

In my opinion this also improves the readability so I think this is a useful change to do. Please also tell me if you have a different opinion.

FYI commentary on the patch should go below the ---.

will note

Quoted 14 lines
Quoted 14 lines

---

 arch/riscv/include/uapi/asm/ucontext.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
(quoted diff) +0 -0

b/arch/riscv/include/uapi/asm/ucontext.h index
44eb993950e5..0cd6f8616985
100644

arch/riscv/include/uapi/asm/ucontext.h +0 -0
@@ -18,7 +18,8 @@ struct ucontext {
 
Quoted 6 lines

arch/riscv/include/uapi/asm/ucontext.h struct ucontext { · line 18

Quoted 1 line
arch/riscv/include/uapi/asm/ucontext.h +0 -0
 	/* There's some padding here to allow sigset_t to be expanded in the

Why fix the closing comment but leave the opening ones incorrect?

Thanks,
Conor.

I mixed the code style up with the one in net/ -will fix

Thanks,
Cleo.

Quoted 23 lines
Quoted 23 lines
arch/riscv/include/uapi/asm/ucontext.h +2 -1
 	 * future.  Though this is unlikely, other architectures put uc_sigmask 
 	 * at the end of this structure and explicitly state it can be
 
-	 * expanded, so we didn't want to box ourselves in here. */
+	 * expanded, so we didn't want to box ourselves in here.
+	 */
 
arch/riscv/include/uapi/asm/ucontext.h +2 -1
 	__u8		  __unused[1024 / 8 - sizeof(sigset_t)];
 	/* We can't put uc_sigmask at the end of this structure because we need
 	 * to be able to expand sigcontext in the future.  For example, the
@@ -27,7 +28,8 @@ struct ucontext {
 
 	 * ucontext, so we're putting this at the end in order to allowb for
 	 * infinite extensibility.  Since we know this will be extended and we
 	 * assume sigset_t won't be extended an extreme amount, we're
 
-	 * prioritizing this. */
+	 * prioritizing this.
+	 */
 

struct sigcontext uc_mcontext;

};