M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

manual: update artiq_coreconfig parameter's syntax

This commit is contained in:
Yann Sionneau 2015-06-17 16:46:39 +02:00
parent afc70926d7
commit 250f9e0bc0
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/manual/installing.rst
View File

@ -265,7 +265,7 @@ To flash the ``idle`` kernel:
* Write it into the core device configuration flash storage: ::
$ artiq_coreconfig -f idle_kernel idle.elf
$ artiq_coreconfig write -f idle_kernel idle.elf
.. note:: You can find more information about how to use the ``artiq_coreconfig`` tool on the :ref:`Utilities <core-device-configuration-tool>` page.

22
doc/manual/utilities.rst
View File

@ -109,38 +109,38 @@ When not specified, the artiq_coreconfig tool will assume that there is a file n
To read the record whose key is ``mac``::
$ artiq_coreconfig -r mac
$ artiq_coreconfig read -k mac
To write the value ``test_value`` in the key ``my_key``::
$ artiq_coreconfig -w my_key test_value
$ artiq_coreconfig -r my_key
$ artiq_coreconfig write -s my_key test_value
$ artiq_coreconfig read -k my_key
b'test_value'
You can also write entire files in a record using the ``-f`` parameter. This is useful for instance to write the ``idle`` kernel in the flash storage::
$ artiq_coreconfig -f idle_kernel idle.elf
$ artiq_coreconfig -r idle_kernel | head -c9
$ artiq_coreconfig write -f idle_kernel idle.elf
$ artiq_coreconfig read -k idle_kernel | head -c9
b'\x7fELF
You can write several records at once::
$ artiq_coreconfig -w key1 value1 -f key2 filename -w key3 value3
$ artiq_coreconfig write -s key1 value1 -f key2 filename -s key3 value3
To remove the previously written key ``my_key``::
$ artiq_coreconfig -d my_key
$ artiq_coreconfig delete -k my_key
To erase the entire flash storage area::
$ artiq_coreconfig -e
$ artiq_coreconfig erase
You don't need to remove a record in order to change its value, just overwrite
it::
$ artiq_coreconfig -w my_key some_value
$ artiq_coreconfig -w my_key some_other_value
$ artiq_coreconfig -r my_key
$ artiq_coreconfig write -s my_key some_value
$ artiq_coreconfig write -s my_key some_other_value
$ artiq_coreconfig read -k my_key
b'some_other_value'
.. argparse::