[v3] Documentation/rv: Fix dead link to monitor_synthesis.rst

[PATCH v3] Documentation/rv: Fix dead link to monitor_synthesis.rst

Posted by Soham Metha 2 weeks, 1 day ago

The file 'da_monitor_synthesis.rst' was renamed to 'monitor_synthesis.rst' in
commit f40a7c06020709
("Documentation/rv: Prepare monitor synthesis document for LTL inclusion").

Signed-off-by: Soham Metha <sohammetha01@gmail.com>
---
Changelog:
v3:
- use a 14 character commit hash
- unwrap Code Blocks so that the references can be linked
v2:
- Use proper commit SHA reference syntax

 Documentation/trace/rv/da_monitor_instrumentation.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/trace/rv/da_monitor_instrumentation.rst b/Documentation/trace/rv/da_monitor_instrumentation.rst
index 6c67c7b57811..9eff38a4ad1f 100644
--- a/Documentation/trace/rv/da_monitor_instrumentation.rst
+++ b/Documentation/trace/rv/da_monitor_instrumentation.rst
@@ -162,10 +162,10 @@ For example, from the wip sample model::
 
 The probes then need to be detached at the disable phase.
 
-[1] The wip model is presented in::
+[1] The wip model is presented in:
 
   Documentation/trace/rv/deterministic_automata.rst
 
-The wip monitor is presented in::
+The wip monitor is presented in:
 
-  Documentation/trace/rv/da_monitor_synthesis.rst
+  Documentation/trace/rv/monitor_synthesis.rst
-- 
2.34.1

Re: [PATCH v3] Documentation/rv: Fix dead link to monitor_synthesis.rst

Posted by Bagas Sanjaya 2 weeks, 1 day ago

On Thu, Dec 04, 2025 at 08:54:52AM +0530, Soham Metha wrote:
> diff --git a/Documentation/trace/rv/da_monitor_instrumentation.rst b/Documentation/trace/rv/da_monitor_instrumentation.rst
> index 6c67c7b57811..9eff38a4ad1f 100644
> --- a/Documentation/trace/rv/da_monitor_instrumentation.rst
> +++ b/Documentation/trace/rv/da_monitor_instrumentation.rst
> @@ -162,10 +162,10 @@ For example, from the wip sample model::
>  
>  The probes then need to be detached at the disable phase.
>  
> -[1] The wip model is presented in::
> +[1] The wip model is presented in:
>  
>    Documentation/trace/rv/deterministic_automata.rst
>  
> -The wip monitor is presented in::
> +The wip monitor is presented in:
>  
> -  Documentation/trace/rv/da_monitor_synthesis.rst
> +  Documentation/trace/rv/monitor_synthesis.rst

Looks good, thanks!

Fixes: f40a7c06020709 ("Documentation/rv: Prepare monitor synthesis document for LTL inclusion")
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

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

Re: [PATCH v3] Documentation/rv: Fix dead link to monitor_synthesis.rst

Posted by Gabriele Monaco 2 weeks, 1 day ago

On Thu, 2025-12-04 at 08:54 +0530, Soham Metha wrote:
> The file 'da_monitor_synthesis.rst' was renamed to 'monitor_synthesis.rst' in
> commit f40a7c06020709
> ("Documentation/rv: Prepare monitor synthesis document for LTL inclusion").
> 
> Signed-off-by: Soham Metha <sohammetha01@gmail.com>

Thanks for catching this!

> ---
> Changelog:
> v3:
> - use a 14 character commit hash
> - unwrap Code Blocks so that the references can be linked

You may want to add this to the commit message next time, you are in fact not
only fixing the broken link.
Since the change is small I wouldn't bother this time, though.

> v2:
> - Use proper commit SHA reference syntax

I suggest you run your patches through script/checkpatch.pl (in the kernel
tree), it's usually finding this kind of formatting issues and even more before
you even send it.
On a side note, apparently it wouldn't have worked this time since you quoted
the hash.

Anyway looks good to me.

Acked-by: Gabriele Monaco <gmonaco@redhat.com>

Thanks,

Gabriele

> 
>  Documentation/trace/rv/da_monitor_instrumentation.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/trace/rv/da_monitor_instrumentation.rst
> b/Documentation/trace/rv/da_monitor_instrumentation.rst
> index 6c67c7b57811..9eff38a4ad1f 100644
> --- a/Documentation/trace/rv/da_monitor_instrumentation.rst
> +++ b/Documentation/trace/rv/da_monitor_instrumentation.rst
> @@ -162,10 +162,10 @@ For example, from the wip sample model::
>  
>  The probes then need to be detached at the disable phase.
>  
> -[1] The wip model is presented in::
> +[1] The wip model is presented in:
>  
>    Documentation/trace/rv/deterministic_automata.rst
>  
> -The wip monitor is presented in::
> +The wip monitor is presented in:
>  
> -  Documentation/trace/rv/da_monitor_synthesis.rst
> +  Documentation/trace/rv/monitor_synthesis.rst

Re: [PATCH v3] Documentation/rv: Fix dead link to monitor_synthesis.rst

Posted by Steven Rostedt 2 weeks, 1 day ago

On Thu, 04 Dec 2025 07:36:57 +0100
Gabriele Monaco <gmonaco@redhat.com> wrote:

> Anyway looks good to me.
> 
> Acked-by: Gabriele Monaco <gmonaco@redhat.com>

Jon,

Care to take this through your tree? Gabriele is the maintainer of this
code.

-- Steve