[PATCH] Documentation/admin-guide: fix typo in cscope command example

eanut 6 posted 1 patch 1 week, 6 days ago
Documentation/admin-guide/workload-tracing.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] Documentation/admin-guide: fix typo in cscope command example
Posted by eanut 6 1 week, 6 days ago
The documentation previously had a typo:
  c"scope -d -p10
which would confuse users. This patch corrects it to:
  cscope -d -p10

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

diff --git a/Documentation/admin-guide/workload-tracing.rst
b/Documentation/admin-guide/workload-tracing.rst
index d6313890ee41..dbdbed4a1b41 100644
--- a/Documentation/admin-guide/workload-tracing.rst
+++ b/Documentation/admin-guide/workload-tracing.rst
@@ -196,7 +196,7 @@ 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
+Note: Run "cscope -R -p10" to build the database and "cscope -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
-- 
2.34.1
Re: [PATCH] Documentation/admin-guide: fix typo in cscope command example
Posted by Randy Dunlap 1 week, 6 days ago
Hi,
[adding Shuah]

On 11/17/25 10:56 PM, eanut 6 wrote:
> The documentation previously had a typo:
>   c"scope -d -p10
> which would confuse users. This patch corrects it to:
>   cscope -d -p10
> 
> Signed-off-by: Jiakai Xu <jiakaiPeanut@gmail.com>
> ---
>  Documentation/admin-guide/workload-tracing.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/admin-guide/workload-tracing.rst
> b/Documentation/admin-guide/workload-tracing.rst
> index d6313890ee41..dbdbed4a1b41 100644
> --- a/Documentation/admin-guide/workload-tracing.rst
> +++ b/Documentation/admin-guide/workload-tracing.rst
> @@ -196,7 +196,7 @@ 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

This makes the lines below agree with the 2 lines above,
so it looks good to me.

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

Could you also fix the comment below, please?

> > -Note: Run "cscope -R -p10" to build the database and c"scope -d -p10" to
> +Note: Run "cscope -R -p10" to build the database and "cscope -d -p10" to
>  enter into the browsing session. cscope by default cscope.out database.

                                           by default uses the cscope.out database.
(be careful not to go past 80 characters on that line)

>  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


thanks.
-- 
~Randy
Re: [PATCH] Documentation/admin-guide: fix typo in cscope command example
Posted by eanut 6 1 week, 6 days ago
Hi Randy,

Thank you very much for reviewing my patch
and for your helpful feedback — it was very useful.

I have updated the patch accordingly and sent out PATCH v2,
which includes the additional fix for the documentation
comment line as you suggested.

Thanks again for your review and guidance.

Best regards,
Jiakai