[PATCH] rv: Fix documentation reference in da_monitor.h

Shubham Sharma posted 1 patch 2 months ago
There is a newer version of this series
include/rv/da_monitor.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] rv: Fix documentation reference in da_monitor.h
Posted by Shubham Sharma 2 months ago
Update documentation reference to reflect the file rename.
Monitor synthesis documentation was renamed in commit f40a7c060207
(\"Documentation/rv: Prepare monitor synthesis document for LTL inclusion\")
from da_monitor_synthesis.rst to monitor_synthesis.rst.

Signed-off-by: Shubham Sharma <slopixelz@gmail.com>
---
 include/rv/da_monitor.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/rv/da_monitor.h b/include/rv/da_monitor.h
index 0cef64366538..810cfb140131 100644
--- a/include/rv/da_monitor.h
+++ b/include/rv/da_monitor.h
@@ -8,7 +8,7 @@
  * The dot2k tool is available at tools/verification/dot2k/
  *
  * For further information, see:
- *   Documentation/trace/rv/da_monitor_synthesis.rst
+ *   Documentation/trace/rv/monitor_synthesis.rst
  */
 
 #include <rv/automata.h>
-- 
2.43.0
Re: [PATCH] rv: Fix documentation reference in da_monitor.h
Posted by Gabriele Monaco 1 month, 2 weeks ago
On Mon, 2025-12-08 at 02:25 +0530, Shubham Sharma wrote:
> Update documentation reference to reflect the file rename.
> Monitor synthesis documentation was renamed in commit f40a7c060207
> (\"Documentation/rv: Prepare monitor synthesis document for LTL inclusion\")
> from da_monitor_synthesis.rst to monitor_synthesis.rst.
> 
> Signed-off-by: Shubham Sharma <slopixelz@gmail.com>

Hi Shubham,

thanks for catching this! I see the same problem is visible in the rvgen
comments (tools/verification/rvgen/{__main__.py,rvgen/dot2k.py}) but that's a
separate thing to fix.

The backslashes before the quotes are not required in the commit message, would
you mind removing them:

> commit f40a7c060207
> ("Documentation/rv: Prepare monitor synthesis document for LTL inclusion")

Other than that it looks good.

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

Thanks,

Gabriele

> ---
>  include/rv/da_monitor.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/rv/da_monitor.h b/include/rv/da_monitor.h
> index 0cef64366538..810cfb140131 100644
> --- a/include/rv/da_monitor.h
> +++ b/include/rv/da_monitor.h
> @@ -8,7 +8,7 @@
>   * The dot2k tool is available at tools/verification/dot2k/
>   *
>   * For further information, see:
> - *   Documentation/trace/rv/da_monitor_synthesis.rst
> + *   Documentation/trace/rv/monitor_synthesis.rst
>   */
>  
>  #include <rv/automata.h>