aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoerg Hofrichter <joerg.hofrichter@ni.com>2020-11-26 14:41:05 +0100
committermichael-west <michael.west@ettus.com>2020-12-04 12:05:26 -0800
commit225fa105b6bffa5e60f9eb4f5d3c04cf62f9c91a (patch)
tree172b79c4f97ed65d26577071ed637569938ae4b6
parentf970d46c56687d2570cc671733ff7736f9ae778b (diff)
downloaduhd-225fa105b6bffa5e60f9eb4f5d3c04cf62f9c91a.tar.gz
uhd-225fa105b6bffa5e60f9eb4f5d3c04cf62f9c91a.tar.bz2
uhd-225fa105b6bffa5e60f9eb4f5d3c04cf62f9c91a.zip
docs: mpm: correct ? notation to display help
For displaying the docstring of a command, the ? character needs to be prepended to the command, not appended.
-rw-r--r--host/docs/mpm.dox4
1 files changed, 2 insertions, 2 deletions
diff --git a/host/docs/mpm.dox b/host/docs/mpm.dox
index 2642eca42..d53025fb5 100644
--- a/host/docs/mpm.dox
+++ b/host/docs/mpm.dox
@@ -71,9 +71,9 @@ argument is a network address at which the device can be reached.
If the connection succeeds, commands can be directly entered on the command
line. MPM Shell supports tab completion and on-line help using the `?` operator:
-By appending it to a command, its docstring will be displayed.
+By prepending it to a command, its docstring will be displayed.
- > get_clock_source?
+ > ?get_clock_source
Arguments to the commands can simply be appended to the command itself: