From d128999938d6b44f52f4d0c6e1f5169ab3c1e7a5 Mon Sep 17 00:00:00 2001 From: Brianna Laugher Date: Fri, 12 Feb 2021 22:15:43 +1100 Subject: [PATCH] tools: Add filesystem action examples to pyboard.py help. Signed-off-by: Brianna Laugher --- docs/reference/pyboard.py.rst | 4 +++- tools/pyboard.py | 6 +++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/reference/pyboard.py.rst b/docs/reference/pyboard.py.rst index 30230eebc3..4fedbb7aab 100644 --- a/docs/reference/pyboard.py.rst +++ b/docs/reference/pyboard.py.rst @@ -48,7 +48,9 @@ Running ``pyboard.py --help`` gives the following output: available --follow follow the output after running the scripts [default if no scripts given] - -f, --filesystem perform a filesystem action + -f, --filesystem perform a filesystem action: cp local :device | cp + :device local | cat path | ls [path] | rm path | mkdir + path | rmdir path Running a command on the device ------------------------------- diff --git a/tools/pyboard.py b/tools/pyboard.py index 3ecdf03f15..069f7490d0 100755 --- a/tools/pyboard.py +++ b/tools/pyboard.py @@ -651,7 +651,11 @@ def main(): help="Do not follow the output after running the scripts.", ) cmd_parser.add_argument( - "-f", "--filesystem", action="store_true", help="perform a filesystem action" + "-f", + "--filesystem", + action="store_true", + help="perform a filesystem action: " + "cp local :device | cp :device local | cat path | ls [path] | rm path | mkdir path | rmdir path", ) cmd_parser.add_argument("files", nargs="*", help="input files") args = cmd_parser.parse_args()