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

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

[Jiakai Xu]

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.

Signed-off-by: Jiakai Xu <jiakaiPeanut@gmail.com>
---

Changes since v2:
 * Fixed line-wrapping issues to ensure patch applies cleanly.
 * Formatting improvements in the commit message.
Thanks to Jonathan Corbet for pointing out this additional correction.

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
 * [PATCH v2] Documentation/admin-guide: fix typo and comment in cscope example
https://lore.kernel.org/linux-doc/871plv5mlf.fsf@trenco.lwn.net/T/#m10f8ec032dd57eaf7388939da3722c9f4b599b33
 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..35963491b9f1 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 v3] Documentation/admin-guide: fix typo and comment in cscope example

[Randy Dunlap]

On 11/18/25 10:57 PM, Jiakai Xu wrote:
> 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.
> 
> Signed-off-by: Jiakai Xu <jiakaiPeanut@gmail.com>

LGTM. Thanks.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

> ---
> 
> Changes since v2:
>  * Fixed line-wrapping issues to ensure patch applies cleanly.
>  * Formatting improvements in the commit message.
> Thanks to Jonathan Corbet for pointing out this additional correction.
> 
> 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
>  * [PATCH v2] Documentation/admin-guide: fix typo and comment in cscope example
> https://lore.kernel.org/linux-doc/871plv5mlf.fsf@trenco.lwn.net/T/#m10f8ec032dd57eaf7388939da3722c9f4b599b33
>  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..35963491b9f1 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?
>  ==================================

-- 
~Randy

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

[Jonathan Corbet]

Jiakai Xu <jiakaipeanut@gmail.com> writes:

> 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.
>
> Signed-off-by: Jiakai Xu <jiakaiPeanut@gmail.com>
> ---
>
> Changes since v2:
>  * Fixed line-wrapping issues to ensure patch applies cleanly.
>  * Formatting improvements in the commit message.
> Thanks to Jonathan Corbet for pointing out this additional correction.
>
> 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
>  * [PATCH v2] Documentation/admin-guide: fix typo and comment in cscope example
> https://lore.kernel.org/linux-doc/871plv5mlf.fsf@trenco.lwn.net/T/#m10f8ec032dd57eaf7388939da3722c9f4b599b33
>  Documentation/admin-guide/workload-tracing.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)

Applied, thanks.

jon