Skip to content

Commit 250f9e0

Browse files
committedJun 17, 2015
manual: update artiq_coreconfig parameter's syntax
1 parent afc7092 commit 250f9e0

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed
 

Diff for: ‎doc/manual/installing.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ To flash the ``idle`` kernel:
265265

266266
* Write it into the core device configuration flash storage: ::
267267

268-
$ artiq_coreconfig -f idle_kernel idle.elf
268+
$ artiq_coreconfig write -f idle_kernel idle.elf
269269

270270
.. note:: You can find more information about how to use the ``artiq_coreconfig`` tool on the :ref:`Utilities <core-device-configuration-tool>` page.
271271

Diff for: ‎doc/manual/utilities.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -109,38 +109,38 @@ When not specified, the artiq_coreconfig tool will assume that there is a file n
109109

110110
To read the record whose key is ``mac``::
111111

112-
$ artiq_coreconfig -r mac
112+
$ artiq_coreconfig read -k mac
113113

114114
To write the value ``test_value`` in the key ``my_key``::
115115

116-
$ artiq_coreconfig -w my_key test_value
117-
$ artiq_coreconfig -r my_key
116+
$ artiq_coreconfig write -s my_key test_value
117+
$ artiq_coreconfig read -k my_key
118118
b'test_value'
119119

120120
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::
121121

122-
$ artiq_coreconfig -f idle_kernel idle.elf
123-
$ artiq_coreconfig -r idle_kernel | head -c9
122+
$ artiq_coreconfig write -f idle_kernel idle.elf
123+
$ artiq_coreconfig read -k idle_kernel | head -c9
124124
b'\x7fELF
125125

126126
You can write several records at once::
127127

128-
$ artiq_coreconfig -w key1 value1 -f key2 filename -w key3 value3
128+
$ artiq_coreconfig write -s key1 value1 -f key2 filename -s key3 value3
129129

130130
To remove the previously written key ``my_key``::
131131

132-
$ artiq_coreconfig -d my_key
132+
$ artiq_coreconfig delete -k my_key
133133

134134
To erase the entire flash storage area::
135135

136-
$ artiq_coreconfig -e
136+
$ artiq_coreconfig erase
137137

138138
You don't need to remove a record in order to change its value, just overwrite
139139
it::
140140

141-
$ artiq_coreconfig -w my_key some_value
142-
$ artiq_coreconfig -w my_key some_other_value
143-
$ artiq_coreconfig -r my_key
141+
$ artiq_coreconfig write -s my_key some_value
142+
$ artiq_coreconfig write -s my_key some_other_value
143+
$ artiq_coreconfig read -k my_key
144144
b'some_other_value'
145145

146146
.. argparse::

0 commit comments

Comments
 (0)
Please sign in to comment.