2023-04-12 18:40:27

by Lin Yu Chen

[permalink] [raw]
Subject: [PATCH] docs: trace: Fix typo in ftrace.rst

There is a typo in the sentence "A kernel developer must be
conscience ...". The word conscience should be conscious.
This patch fixes it.

Signed-off-by: Lin Yu Chen <[email protected]>
---
Documentation/trace/ftrace.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/trace/ftrace.rst b/Documentation/trace/ftrace.rst
index b927fb2b94dc..e8bca5fea7cc 100644
--- a/Documentation/trace/ftrace.rst
+++ b/Documentation/trace/ftrace.rst
@@ -3510,7 +3510,7 @@ directories, the rmdir will fail with EBUSY.
Stack trace
-----------
Since the kernel has a fixed sized stack, it is important not to
-waste it in functions. A kernel developer must be conscience of
+waste it in functions. A kernel developer must be conscious of
what they allocate on the stack. If they add too much, the system
can be in danger of a stack overflow, and corruption will occur,
usually leading to a system panic.
--
2.25.1


2023-04-13 02:36:58

by Bagas Sanjaya

[permalink] [raw]
Subject: Re: [PATCH] docs: trace: Fix typo in ftrace.rst

On 4/13/23 01:37, Lin Yu Chen wrote:
> There is a typo in the sentence "A kernel developer must be
> conscience ...". The word conscience should be conscious.
> This patch fixes it.
>

Please don't say "This patch does foo".

> -waste it in functions. A kernel developer must be conscience of
> +waste it in functions. A kernel developer must be conscious of

Alternatively, what about "aware of"?

--
An old man doll... just what I always wanted! - Clara

2023-04-13 03:07:54

by Steven Rostedt

[permalink] [raw]
Subject: Re: [PATCH] docs: trace: Fix typo in ftrace.rst

On Thu, 13 Apr 2023 09:19:12 +0700
Bagas Sanjaya <[email protected]> wrote:

> On 4/13/23 01:37, Lin Yu Chen wrote:
> > There is a typo in the sentence "A kernel developer must be
> > conscience ...". The word conscience should be conscious.
> > This patch fixes it.
> >
>
> Please don't say "This patch does foo".

Yes, that part can be left out.

>
> > -waste it in functions. A kernel developer must be conscience of
> > +waste it in functions. A kernel developer must be conscious of
>
> Alternatively, what about "aware of"?
>

As the author of this document, and the one that doesn't have a conscience
about using conscious correctly, I approve of Lin Yu's change.

Acked-by: Steven Rostedt (Google) <[email protected]>

Thanks!

-- Steve

2023-04-20 16:24:24

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] docs: trace: Fix typo in ftrace.rst

Lin Yu Chen <[email protected]> writes:

> There is a typo in the sentence "A kernel developer must be
> conscience ...". The word conscience should be conscious.
> This patch fixes it.
>
> Signed-off-by: Lin Yu Chen <[email protected]>
> ---
> Documentation/trace/ftrace.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/trace/ftrace.rst b/Documentation/trace/ftrace.rst
> index b927fb2b94dc..e8bca5fea7cc 100644
> --- a/Documentation/trace/ftrace.rst
> +++ b/Documentation/trace/ftrace.rst
> @@ -3510,7 +3510,7 @@ directories, the rmdir will fail with EBUSY.
> Stack trace
> -----------
> Since the kernel has a fixed sized stack, it is important not to
> -waste it in functions. A kernel developer must be conscience of
> +waste it in functions. A kernel developer must be conscious of
> what they allocate on the stack. If they add too much, the system
> can be in danger of a stack overflow, and corruption will occur,

Applied, thanks.

jon