[PATCH v2] Documentation/admin-guide: fix typo and comment in cscope example

[PATCH v2] Documentation/admin-guide: fix typo and comment in cscope example

[eanut 6]

This patch updates the Linux documentation for cscope, fixing two issues:
1. Corrects the typo in the command line:
       c"scope -d -p10  ->  cscope -d -p10
2. Fixes the related documentation comment for clarity and correctness:
       cscope by default cscope.out database.
       ->
       cscope by default uses the cscope.out database.

Changes since v1:
 * Added the second fix for the documentation comment line.
Thanks to Randy Dunlap for pointing out this additional correction.

References:
 * [PATCH] Documentation/admin-guide: fix typo in cscope command example
https://lore.kernel.org/linux-doc/6017104c-740d-43db-bc53-58751ec57282@infradead.org/T/#t

Signed-off-by: Jiakai Xu <jiakaiPeanut@gmail.com>
---
 Documentation/admin-guide/workload-tracing.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/admin-guide/workload-tracing.rst
b/Documentation/admin-guide/workload-tracing.rst
index d6313890ee41..1751368bc3da 100644
--- a/Documentation/admin-guide/workload-tracing.rst
+++ b/Documentation/admin-guide/workload-tracing.rst
@@ -196,11 +196,11 @@ Let’s checkout the latest Linux repository and
build cscope database::
   cscope -R -p10  # builds cscope.out database before starting browse session
   cscope -d -p10  # starts browse session on cscope.out database

-Note: Run "cscope -R -p10" to build the database and c"scope -d -p10" to
-enter into the browsing session. cscope by default cscope.out database.
-To get out of this mode press ctrl+d. -p option is used to specify the
-number of file path components to display. -p10 is optimal for browsing
-kernel sources.
+Note: Run "cscope -R -p10" to build the database and "cscope -d -p10" to
+enter into the browsing session. cscope by default uses the cscope.out
+database. To get out of this mode press ctrl+d. -p option is used to
+specify the number of file path components to display. -p10 is optimal
+for browsing kernel sources.

 What is perf and how do we use it?
 ==================================
-- 
2.34.1

Re: [PATCH v2] Documentation/admin-guide: fix typo and comment in cscope example

[Jonathan Corbet]

eanut 6 <jiakaipeanut@gmail.com> writes:

Thanks for working to improve our documentation.

> This patch updates the Linux documentation for cscope, fixing two issues:
> 1. Corrects the typo in the command line:
>        c"scope -d -p10  ->  cscope -d -p10
> 2. Fixes the related documentation comment for clarity and correctness:
>        cscope by default cscope.out database.
>        ->
>        cscope by default uses the cscope.out database.
>
> Changes since v1:
>  * Added the second fix for the documentation comment line.
> Thanks to Randy Dunlap for pointing out this additional correction.

This kind of information belongs below the "---" line so that the
maintainer doesn't have to edit it out later.

> References:
>  * [PATCH] Documentation/admin-guide: fix typo in cscope command example
> https://lore.kernel.org/linux-doc/6017104c-740d-43db-bc53-58751ec57282@infradead.org/T/#t
>
> Signed-off-by: Jiakai Xu <jiakaiPeanut@gmail.com>
> ---
>  Documentation/admin-guide/workload-tracing.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/admin-guide/workload-tracing.rst
> b/Documentation/admin-guide/workload-tracing.rst

This patch has been line-wrapped by your email client and does not
apply.  Please, before resending, send the patch to yourself and be sure
that you can apply the result.

Thanks,

jon

Re: [PATCH v2] Documentation/admin-guide: fix typo and comment in cscope example

[eanut 6]

Hi Jon,

Thank you for the review and the guidance.

I’ve sent a v3 of the patch.

Thanks again for your help.

Best regards,
Jiakai