diff mbox series

docs: trace: Fix typo in ftrace.rst

Message ID 20230412183739.89894-1-starpt.official@gmail.com (mailing list archive)
State Accepted
Commit c9b951c3136fb04a9bb89deef5bba8e262410f68
Headers show
Series docs: trace: Fix typo in ftrace.rst | expand

Commit Message

Lin Yu Chen April 12, 2023, 6:37 p.m. UTC
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 <starpt.official@gmail.com>
---
 Documentation/trace/ftrace.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Bagas Sanjaya April 13, 2023, 2:19 a.m. UTC | #1
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"?
Steven Rostedt April 13, 2023, 2:38 a.m. UTC | #2
On Thu, 13 Apr 2023 09:19:12 +0700
Bagas Sanjaya <bagasdotme@gmail.com> 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) <rostedt@goodmis.org>

Thanks!

-- Steve
Jonathan Corbet April 20, 2023, 4:13 p.m. UTC | #3
Lin Yu Chen <starpt.official@gmail.com> 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 <starpt.official@gmail.com>
> ---
>  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
diff mbox series

Patch

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.