From cf17be92e3c651a2aa635eb55d20a7835b0e5900 Mon Sep 17 00:00:00 2001 From: Robert Jordens Date: Mon, 18 Jan 2016 21:41:42 -0700 Subject: [PATCH] doc: add artiq_flash --- artiq/frontend/artiq_flash.py | 7 ++++++- doc/manual/utilities.rst | 11 +++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/artiq/frontend/artiq_flash.py b/artiq/frontend/artiq_flash.py index 2cc1bd6c1..df3b330a0 100755 --- a/artiq/frontend/artiq_flash.py +++ b/artiq/frontend/artiq_flash.py @@ -10,7 +10,7 @@ import artiq from artiq.frontend.bit2bin import bit2bin -def main(): +def get_argparser(): parser = argparse.ArgumentParser( formatter_class=argparse.RawDescriptionHelpFormatter, description="ARTIQ flashing/deployment tool", @@ -43,6 +43,11 @@ Prerequisites: parser.add_argument("ACTION", nargs="*", default="proxy bitstream bios runtime start".split(), help="actions to perform, default: %(default)s") + return parser + + +def main(): + parser = get_argparser() opts = parser.parse_args() config = { diff --git a/doc/manual/utilities.rst b/doc/manual/utilities.rst index c7d9e7274..c79f6cc6a 100644 --- a/doc/manual/utilities.rst +++ b/doc/manual/utilities.rst @@ -1,6 +1,10 @@ Utilities ========= +.. Sort these tool by some subjective combination of their + typical sequence and expected frequency of use. + + Local running tool ------------------ @@ -93,6 +97,13 @@ This tool compiles key/value pairs into a binary image suitable for flashing int :ref: artiq.frontend.artiq_mkfs.get_argparser :prog: artiq_mkfs +Flashing/Loading tool +--------------------- + +.. argparse:: + :ref: artiq.frontend.artiq_flash.get_argparser + :prog: artiq_flash + .. _core-device-configuration-tool: Core device configuration tool