Commit afc70ccb authored by Daniel Bristot de Oliveira's avatar Daniel Bristot de Oliveira Committed by Steven Rostedt (Google)
Browse files

Documentation/rv: Add verification/rv man pages 

Add man pages for the rv command line, using the same scheme we used
in rtla.

Link: https://lkml.kernel.org/r/e841d7cfbdfc3ebdaf7cbd40278571940145d829.1668180100.git.bristot@kernel.org



Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarDaniel Bristot de Oliveira <bristot@kernel.org>
Signed-off-by: default avatarSteven Rostedt (Google) <rostedt@goodmis.org>
parent 6d60f896

Documentation/tools/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -11,6 +11,7 @@ more additions are needed here: 
   :maxdepth: 1



   rtla/index

   rv/index



.. only::  subproject and html

Documentation/tools/rv/Makefile

0 → 100644
+52 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0-only



INSTALL		?= install

RM		?= rm -f

RMDIR		?= rmdir --ignore-fail-on-non-empty



PREFIX		?= /usr/share

MANDIR		?= $(PREFIX)/man

MAN1DIR		= $(MANDIR)/man1



MAN1_RST	= $(wildcard rv*.rst)



_DOC_MAN1	= $(patsubst %.rst,%.1,$(MAN1_RST))

DOC_MAN1	= $(addprefix $(OUTPUT),$(_DOC_MAN1))



RST2MAN_DEP	:= $(shell command -v rst2man 2>/dev/null)

RST2MAN_OPTS	+= --verbose



TEST_RST2MAN = $(shell sh -c "rst2man --version > /dev/null 2>&1 || echo n")



$(OUTPUT)%.1: %.rst

ifndef RST2MAN_DEP

	$(info ********************************************)

	$(info ** NOTICE: rst2man not found)

	$(info **)

	$(info ** Consider installing the latest rst2man from your)

	$(info ** distribution, e.g., 'dnf install python3-docutils' on Fedora,)

	$(info ** or from source:)

	$(info **)

	$(info **  https://docutils.sourceforge.io/docs/dev/repository.html )

	$(info **)

	$(info ********************************************)

	$(error NOTICE: rst2man required to generate man pages)

endif

	rst2man $(RST2MAN_OPTS) $< > $@



man1: $(DOC_MAN1)

man: man1



clean:

	$(RM) $(DOC_MAN1)



install: man

	$(INSTALL) -d -m 755 $(DESTDIR)$(MAN1DIR)

	$(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(MAN1DIR)



uninstall:

	$(RM) $(addprefix $(DESTDIR)$(MAN1DIR)/,$(_DOC_MAN1))

	$(RMDIR) $(DESTDIR)$(MAN1DIR)



.PHONY: man man1 clean install uninstall

.DEFAULT_GOAL := man

Documentation/tools/rv/common_appendix.rst

0 → 100644
+16 −0
Original line number Diff line number Diff line 
REPORTING BUGS

==============



Report bugs to <linux-kernel@vger.kernel.org>

and <linux-trace-devel@vger.kernel.org>



LICENSE

=======



**rv** is Free Software licensed under the GNU GPLv2



COPYING

=======



Copyright \(C) 2022 Red Hat, Inc. Free use of this software is granted under

the terms of the GNU Public License (GPL).

Documentation/tools/rv/common_ikm.rst

0 → 100644
+21 −0
Original line number Diff line number Diff line 
**-h**, **--help**



        Print the monitor's options and the available reactors list.



**-r**, **--reactor** *reactor*



        Enables the *reactor*. See **-h** for a list of available reactors.



**-s**, **--self**



        When tracing (**-t**), also print the events that happened during the **rv**

        command itself. If the **rv** command itself generates too many events,

        the tool might get busy processing its own events only.



**-t**, **--trace**



        Trace monitor's events and error.



**-v**, **--verbose**



        Print debug messages.

Documentation/tools/rv/index.rst

0 → 100644
+24 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



==============================

Runtime verification (rv) tool

==============================



**rv** tool provides the interface for a collection of runtime verification

(rv) monitors.



.. toctree::

   :maxdepth: 1



   rv

   rv-list

   rv-mon

   rv-mon-wip

   rv-mon-wwnr



.. only::  subproject and html



   Indices

   =======



   * :ref:`genindex`