[PATCH 5/5] Documentation: trace: histogram: Link to ftrace docs

Bagas Sanjaya posted 5 patches 3 weeks ago
[PATCH 5/5] Documentation: trace: histogram: Link to ftrace docs
Posted by Bagas Sanjaya 3 weeks ago
In brief "Extended error information" section, details on error
condition is referred to ftrace docs. Add the link to it.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/trace/histogram.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/trace/histogram.rst b/Documentation/trace/histogram.rst
index d158dadaa42447..340bcb5099e7a4 100644
--- a/Documentation/trace/histogram.rst
+++ b/Documentation/trace/histogram.rst
@@ -209,8 +209,8 @@ Documentation written by Tom Zanussi
 
   For some error conditions encountered when invoking a hist trigger
   command, extended error information is available via the
-  tracing/error_log file.  See Error Conditions in
-  :file:`Documentation/trace/ftrace.rst` for details.
+  tracing/error_log file.  See "Error conditions" section in
+  Documentation/trace/ftrace.rst for details.
 
 2.3. 'hist' trigger examples
 ----------------------------
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH 5/5] Documentation: trace: histogram: Link to ftrace docs
Posted by Tom Zanussi 2 weeks, 3 days ago
On Thu, 2025-09-11 at 11:25 +0700, Bagas Sanjaya wrote:
> In brief "Extended error information" section, details on error
> condition is referred to ftrace docs. Add the link to it.

Reviewed-by: Tom Zanussi <zanussi@kernel.org>

> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/trace/histogram.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/trace/histogram.rst
> b/Documentation/trace/histogram.rst
> index d158dadaa42447..340bcb5099e7a4 100644
> --- a/Documentation/trace/histogram.rst
> +++ b/Documentation/trace/histogram.rst
> @@ -209,8 +209,8 @@ Documentation written by Tom Zanussi
>  
>    For some error conditions encountered when invoking a hist trigger
>    command, extended error information is available via the
> -  tracing/error_log file.  See Error Conditions in
> -  :file:`Documentation/trace/ftrace.rst` for details.
> +  tracing/error_log file.  See "Error conditions" section in
> +  Documentation/trace/ftrace.rst for details.
>  
>  2.3. 'hist' trigger examples
>  ----------------------------
Re: [PATCH 5/5] Documentation: trace: histogram: Link to ftrace docs
Posted by Masami Hiramatsu (Google) 2 weeks, 6 days ago
On Thu, 11 Sep 2025 11:25:27 +0700
Bagas Sanjaya <bagasdotme@gmail.com> wrote:

> In brief "Extended error information" section, details on error
> condition is referred to ftrace docs. Add the link to it.

It seems this does not add the link. Can you make a tag and
link to it?

Thank you,

> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/trace/histogram.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/trace/histogram.rst b/Documentation/trace/histogram.rst
> index d158dadaa42447..340bcb5099e7a4 100644
> --- a/Documentation/trace/histogram.rst
> +++ b/Documentation/trace/histogram.rst
> @@ -209,8 +209,8 @@ Documentation written by Tom Zanussi
>  
>    For some error conditions encountered when invoking a hist trigger
>    command, extended error information is available via the
> -  tracing/error_log file.  See Error Conditions in
> -  :file:`Documentation/trace/ftrace.rst` for details.
> +  tracing/error_log file.  See "Error conditions" section in
> +  Documentation/trace/ftrace.rst for details.
>  
>  2.3. 'hist' trigger examples
>  ----------------------------
> -- 
> An old man doll... just what I always wanted! - Clara
> 


-- 
Masami Hiramatsu (Google) <mhiramat@kernel.org>
Re: [PATCH 5/5] Documentation: trace: histogram: Link to ftrace docs
Posted by Bagas Sanjaya 2 weeks, 6 days ago
On Fri, Sep 12, 2025 at 09:58:27AM +0900, Masami Hiramatsu wrote:
> On Thu, 11 Sep 2025 11:25:27 +0700
> Bagas Sanjaya <bagasdotme@gmail.com> wrote:
> 
> > In brief "Extended error information" section, details on error
> > condition is referred to ftrace docs. Add the link to it.
> 
> It seems this does not add the link. Can you make a tag and
> link to it?

Nope.

What the patch does instead is to convert :file: markup to proper
cross-reference. I will fix the patch description in v2.

Thanks.

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