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.
Signed-off-by: Cleo John <[email protected]>
---
arch/riscv/include/uapi/asm/ucontext.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/arch/riscv/include/uapi/asm/ucontext.h b/arch/riscv/include/uapi/asm/ucontext.h
index 44eb993950e5..0cd6f8616985 100644
--- a/arch/riscv/include/uapi/asm/ucontext.h
+++ b/arch/riscv/include/uapi/asm/ucontext.h
@@ -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;
};
--
2.25.1
On Sun, 9. October 2022, 14:43:02 CEST, Conor Dooley wrote:
> On Sun, Oct 09, 2022 at 02:38:43PM +0200, Cleo John wrote:
> > Hey Connor,
> >
> > On Sun, 9. October 2022, 14:14:52 CEST, Conor Dooley wrote:
> > > Hey Cleo,
> > >
> > > On Sun, Oct 09, 2022 at 02:03:40PM +0200, Cleo John wrote:
> > > > Fixed styling in riscv ucontext header
> > >
> > > This should probably be "riscv: fix styling..."
> >
> > okay yea, I will change this in a second patch.
> >
> > > > 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.
>
okay, this is.. embarrassing.
> > > > 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
> >
> > > > Signed-off-by: Cleo John <[email protected]>
> > > > ---
> > > >
> > > > arch/riscv/include/uapi/asm/ucontext.h | 6 ++++--
> > > > 1 file changed, 4 insertions(+), 2 deletions(-)
> > > >
> > > > diff --git a/arch/riscv/include/uapi/asm/ucontext.h
> > > > b/arch/riscv/include/uapi/asm/ucontext.h index
> > > > 44eb993950e5..0cd6f8616985
> > > > 100644
> > > > --- a/arch/riscv/include/uapi/asm/ucontext.h
> > > > +++ b/arch/riscv/include/uapi/asm/ucontext.h
> > > > @@ -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.
> >
> > I mixed the code style up with the one in net/ -will fix
> >
> > Thanks,
> > Cleo.
> >
> > > > * 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 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;
> > > >
> > > > };
On Sun, Oct 09, 2022 at 02:38:43PM +0200, Cleo John wrote:
> Hey Connor,
>
> On Sun, 9. October 2022, 14:14:52 CEST, Conor Dooley wrote:
> > Hey Cleo,
> >
> > On Sun, Oct 09, 2022 at 02:03:40PM +0200, Cleo John wrote:
> > > Fixed styling in riscv ucontext header
> >
> > This should probably be "riscv: fix styling..."
>
> okay yea, I will change this in a second patch.
>
> > > 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.
> > > 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
>
> > > Signed-off-by: Cleo John <[email protected]>
> > > ---
> > >
> > > arch/riscv/include/uapi/asm/ucontext.h | 6 ++++--
> > > 1 file changed, 4 insertions(+), 2 deletions(-)
> > >
> > > diff --git a/arch/riscv/include/uapi/asm/ucontext.h
> > > b/arch/riscv/include/uapi/asm/ucontext.h index 44eb993950e5..0cd6f8616985
> > > 100644
> > > --- a/arch/riscv/include/uapi/asm/ucontext.h
> > > +++ b/arch/riscv/include/uapi/asm/ucontext.h
> > > @@ -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.
>
> I mixed the code style up with the one in net/ -will fix
>
> Thanks,
> Cleo.
>
> > > * 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;
> > >
> > > };
>