* [PATCH] Documentation: Fixed errors in the title level of coding style documents
@ 2022-07-29 2:34 fslongjin
0 siblings, 0 replies; 3+ messages in thread
From: fslongjin @ 2022-07-29 2:34 UTC (permalink / raw)
To: corbet, twoerner, keescook; +Cc: linux-doc, linux-kernel, fslongjin
In Section 3, `Placing Braces and Spaces`. In the previous document, only
`Spaces` is written in the subtitle without the `Braces`. I think this
may be a format error caused by negligence, so I fixed it.
Signed-off-by: fslongjin <longjin@RinGoTek.cn>
---
Documentation/process/coding-style.rst | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index 03eb53fd029a..2a26bcb9f391 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -120,6 +120,9 @@ that breaks the ability to grep for them.
3) Placing Braces and Spaces
----------------------------
+3.1) Braces
+***********
+
The other issue that always comes up in C styling is the placement of
braces. Unlike the indent size, there are few technical reasons to
choose one placement strategy over the other, but the preferred way, as
@@ -231,7 +234,7 @@ Also, use braces when a loop contains more than a single simple statement:
do_something();
}
-3.1) Spaces
+3.2) Spaces
***********
Linux kernel style for use of spaces depends (mostly) on
--
2.20.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] Documentation: Fixed errors in the title level of coding style documents
2022-07-28 7:42 fslongjin
@ 2022-07-28 15:15 ` Jonathan Corbet
0 siblings, 0 replies; 3+ messages in thread
From: Jonathan Corbet @ 2022-07-28 15:15 UTC (permalink / raw)
To: fslongjin, twoerner, keescook; +Cc: linux-doc, linux-kernel, fslongjin, longjin
fslongjin <longjin@RinGoTek.cn> writes:
> From: fslongjin <fslongjin@vip.qq.com>
>
> In Section 3, `Placing Braces and Spaces`. In the previous document, only
> `Spaces` is written in the subtitle without the `Braces`. I think this
> may be a format error caused by negligence, so I fixed it.
>
> Signed-off-by: longjin <longjin@RinGoTek.cn>
> Signed-off-by: fslongjin <fslongjin@vip.qq.com>
I don't understand this signoff chain; did both of you work on this
small patch?
Signoffs should also have full legal names in them.
> ---
> Documentation/process/coding-style.rst | 5 ++++-
> 1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
> index 03eb53fd029a..2a26bcb9f391 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -120,6 +120,9 @@ that breaks the ability to grep for them.
> 3) Placing Braces and Spaces
> ----------------------------
>
> +3.1) Braces
> +***********
> +
> The other issue that always comes up in C styling is the placement of
> braces. Unlike the indent size, there are few technical reasons to
> choose one placement strategy over the other, but the preferred way, as
> @@ -231,7 +234,7 @@ Also, use braces when a loop contains more than a single simple statement:
> do_something();
> }
>
> -3.1) Spaces
> +3.2) Spaces
> ***********
This seems like a fine change but, as you notice here, putting section
numbers into the text leads to ongoing update problems. Sphinx can add
those nicely, so I generally suggest just removing them entirely. I
wouldn't insist on that, but if you felt so inclined, that would be a
good improvement to the patch.
Thanks,
jon
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH] Documentation: Fixed errors in the title level of coding style documents
@ 2022-07-28 7:42 fslongjin
2022-07-28 15:15 ` Jonathan Corbet
0 siblings, 1 reply; 3+ messages in thread
From: fslongjin @ 2022-07-28 7:42 UTC (permalink / raw)
To: corbet, twoerner, keescook; +Cc: linux-doc, linux-kernel, fslongjin, longjin
From: fslongjin <fslongjin@vip.qq.com>
In Section 3, `Placing Braces and Spaces`. In the previous document, only
`Spaces` is written in the subtitle without the `Braces`. I think this
may be a format error caused by negligence, so I fixed it.
Signed-off-by: longjin <longjin@RinGoTek.cn>
Signed-off-by: fslongjin <fslongjin@vip.qq.com>
---
Documentation/process/coding-style.rst | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index 03eb53fd029a..2a26bcb9f391 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -120,6 +120,9 @@ that breaks the ability to grep for them.
3) Placing Braces and Spaces
----------------------------
+3.1) Braces
+***********
+
The other issue that always comes up in C styling is the placement of
braces. Unlike the indent size, there are few technical reasons to
choose one placement strategy over the other, but the preferred way, as
@@ -231,7 +234,7 @@ Also, use braces when a loop contains more than a single simple statement:
do_something();
}
-3.1) Spaces
+3.2) Spaces
***********
Linux kernel style for use of spaces depends (mostly) on
--
2.20.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-07-29 2:36 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-07-29 2:34 [PATCH] Documentation: Fixed errors in the title level of coding style documents fslongjin
-- strict thread matches above, loose matches on Subject: below --
2022-07-28 7:42 fslongjin
2022-07-28 15:15 ` Jonathan Corbet
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.