[Doc] Add version command/option to documentation

2021-01-27 16:06:45 -07:00 · 2021-01-27 16:06:45 -07:00 · 78ad9cd000
parent d9fda31a9f
commit 78ad9cd000
2 changed files with 9 additions and 0 deletions
--- a/docs/source/manual/openfpga_shell/launch_openfpga_shell.rst
+++ b/docs/source/manual/openfpga_shell/launch_openfpga_shell.rst
@ -22,6 +22,10 @@ To launch OpenFPGA shell, users can choose two modes.
  - If in batch mode, OpenFPGA will abort immediately when fatal errors occurred.
  - If not in batch mode, OpenFPGA will enter interactive mode when fatal errors occurred.

+.. option::	--version or -v
+
+  Print version information of OpenFPGA
+
 .. option::	--help or -h
 	
  Show the help desk
--- a/docs/source/manual/openfpga_shell/openfpga_commands/basic_commands.rst
+++ b/docs/source/manual/openfpga_shell/openfpga_commands/basic_commands.rst
@ -3,6 +3,11 @@
 Basic Commands
 --------------

+version
+~~~~~~~
+
+  Show OpenFPGA version information
+
 help
 ~~~~