doc: add artiq_flash

This commit is contained in:
Robert Jördens 2016-01-18 21:41:42 -07:00
parent 8674875007
commit cf17be92e3
2 changed files with 17 additions and 1 deletions

View File

@ -10,7 +10,7 @@ import artiq
from artiq.frontend.bit2bin import bit2bin from artiq.frontend.bit2bin import bit2bin
def main(): def get_argparser():
parser = argparse.ArgumentParser( parser = argparse.ArgumentParser(
formatter_class=argparse.RawDescriptionHelpFormatter, formatter_class=argparse.RawDescriptionHelpFormatter,
description="ARTIQ flashing/deployment tool", description="ARTIQ flashing/deployment tool",
@ -43,6 +43,11 @@ Prerequisites:
parser.add_argument("ACTION", nargs="*", parser.add_argument("ACTION", nargs="*",
default="proxy bitstream bios runtime start".split(), default="proxy bitstream bios runtime start".split(),
help="actions to perform, default: %(default)s") help="actions to perform, default: %(default)s")
return parser
def main():
parser = get_argparser()
opts = parser.parse_args() opts = parser.parse_args()
config = { config = {

View File

@ -1,6 +1,10 @@
Utilities Utilities
========= =========
.. Sort these tool by some subjective combination of their
typical sequence and expected frequency of use.
Local running tool 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 :ref: artiq.frontend.artiq_mkfs.get_argparser
:prog: artiq_mkfs :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:
Core device configuration tool Core device configuration tool