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

Soham Metha posted 1 patch 2 weeks, 1 day ago
There is a newer version of this series
Documentation/trace/rv/da_monitor_instrumentation.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH v2] 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 f40a7c060207090f41998025fcd1cfad06ea2780
("Documentation/rv: Prepare monitor synthesis document for LTL inclusion").

Update the reference to point to the new filename.

Signed-off-by: Soham Metha <sohammetha01@gmail.com>
---
Changelog:
- Use proper commit SHA reference syntax

 Documentation/trace/rv/da_monitor_instrumentation.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/trace/rv/da_monitor_instrumentation.rst b/Documentation/trace/rv/da_monitor_instrumentation.rst
index 6c67c7b57811..b847c58a96b6 100644
--- a/Documentation/trace/rv/da_monitor_instrumentation.rst
+++ b/Documentation/trace/rv/da_monitor_instrumentation.rst
@@ -168,4 +168,4 @@ The probes then need to be detached at the disable phase.
 
 The wip monitor is presented in::
 
-  Documentation/trace/rv/da_monitor_synthesis.rst
+  Documentation/trace/rv/monitor_synthesis.rst
-- 
2.34.1
Re: [PATCH v2] Documentation/rv: Fix dead link to monitor_synthesis.rst
Posted by Bagas Sanjaya 2 weeks, 1 day ago
On Wed, Dec 03, 2025 at 11:51:21PM +0530, Soham Metha wrote:
> The file 'da_monitor_synthesis.rst' was renamed to 'monitor_synthesis.rst' in
> commit f40a7c060207090f41998025fcd1cfad06ea2780
> ("Documentation/rv: Prepare monitor synthesis document for LTL inclusion").

[also Cc: people in the commit's SoB chain]

Nit: For commit references, please use abbreviated commit hash (at least 12
characters; I personally prefer 14).

> 
> Update the reference to point to the new filename.
> 
> Signed-off-by: Soham Metha <sohammetha01@gmail.com>

Fixes: f40a7c06020709 ("Documentation/rv: Prepare monitor synthesis document for LTL inclusion")

>  The wip monitor is presented in::
>  
> -  Documentation/trace/rv/da_monitor_synthesis.rst
> +  Documentation/trace/rv/monitor_synthesis.rst

Thanks for the catch! Can you also unwrap the references (which are in
literal code blocks) so that these can be linked? Like:

---- >8 ----
diff --git a/Documentation/trace/rv/da_monitor_instrumentation.rst b/Documentation/trace/rv/da_monitor_instrumentation.rst
index 6c67c7b5781118..9eff38a4ad1ff4 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

Thanks.

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