Skip to content

Commit 8e25859

Browse files
committed
doc: highlight command as bash
Signed-off-by: Stewart Smith <[email protected]>
1 parent 08d6158 commit 8e25859

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

doc/user-guide.rst

+24-8
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ machine:
2727
host_user=root
2828
host_password=abc123
2929
30-
It can be used as such: ::
30+
It can be used as such:
31+
32+
.. code-block:: bash
3133
3234
./op-test --config-file witherspoon.conf
3335
@@ -106,15 +108,19 @@ of `witherspoon.pnor.squashfs.tar` you may need to use `witherspoon.pnor`.
106108

107109
For example, this command will use the ``witherspoon.conf`` configuration file
108110
(see :ref:`config-file`) for login credentials to a Witherspoon machine, and
109-
will flash *host* firmware before running the default test suite: ::
111+
will flash *host* firmware before running the default test suite:
112+
113+
.. code-block:: bash
110114
111115
./op-test --config-file witherspoon.conf \
112116
--host-pnor ~/op-build/output/images/witherspoon.pnor.squashfs.tar
113117
114118
In this example we've provided the *full* path to a witherspoon firmware image
115119
that we've built using `op-build`.
116120

117-
If you *also* want to flash BMC firmware, you can do that with the addition of the ``--bmc-image`` command line option: ::
121+
If you *also* want to flash BMC firmware, you can do that with the addition of the ``--bmc-image`` command line option:
122+
123+
.. code-block:: bash
118124
119125
./op-test --config-file witherspoon.conf \
120126
--bmc-image obmc-phosphor-image-witherspoon.ubi.mtd.tar \
@@ -125,7 +131,9 @@ In this example, `op-test` will first update the BMC firmware, then update the h
125131
If you're a skiboot/OPAL developer and wanting to test your latest code when
126132
applied on top of a known-good BMC and PNOR image, you can use the
127133
``--flash-skiboot`` command line option to instruct `op-test` to, as a final
128-
step, overwrite the `PAYLOAD` partition with your skiboot: ::
134+
step, overwrite the `PAYLOAD` partition with your skiboot:
135+
136+
.. code-block:: bash
129137
130138
./op-test --config-file witherspoon.conf \
131139
--bmc-image obmc-phosphor-image-witherspoon.ubi.mtd.tar \
@@ -159,14 +167,18 @@ firmware.
159167
**TODO** Document HPM flashing.
160168

161169
An example of flashing a full `habanero.pnor` image and running the default
162-
test suite is: ::
170+
test suite is:
171+
172+
.. code-block:: bash
163173
164174
./op-test --config-file hab4.conf \
165175
--host-pnor ~/op-build/output/images/habanero.pnor
166176
167177
Just like on other systems, if you're an OPAL/skiboot developer and you want
168178
to test your changes along with a known-good full PNOR image, you'd do that
169-
the same way, using the ``--flash-skiboot`` parameter: ::
179+
the same way, using the ``--flash-skiboot`` parameter:
180+
181+
.. code-block:: bash
170182
171183
./op-test --config-file hab4.conf \
172184
--host-pnor ~/op-build/output/images/habanero.pnor \
@@ -192,7 +204,9 @@ are split up into two separate LIDs, and must be pointed to separately.
192204

193205
This example will run the stest suite against our ZZ machine *after* flashing
194206
our skiboot, kernel and initramfs built fresh from `op-build` (with the
195-
configuration `zz_defconfig`). ::
207+
configuration `zz_defconfig`).
208+
209+
.. code-block:: bash
196210
197211
./op-test --config-file zz.conf \
198212
--flash-skiboot ~/op-build/output/images/skiboot.lid \
@@ -233,7 +247,9 @@ In this configuration file example, we point to a `qemu` development tree
233247
rather than using the system default `qemu-system-ppc64` binary.
234248

235249
To run the "boot to petitboot" test in qemu with the above configuration file,
236-
you can do so like this: ::
250+
you can do so like this:
251+
252+
.. code-block:: bash
237253
238254
./op-test --config-file qemu.conf \
239255
--run testcases.BasicIPL.BootToPetitbootShell

0 commit comments

Comments
 (0)