Skip to content

Commit 988a3fe

Browse files
committed
doc: use code-block:: none for command examples
The ``.. code-block::`` directive can specify a highlight language for the body of the directive. Previously the languages "none" and "console" were the same, but we're now using "console" for creating terminal-looking output (rather than doing images of terminal windows) with a black background and white text. This PR replaces unintended uses of the "console" highlighting language with "none". Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1 parent dc6d775 commit 988a3fe

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

tools/acrn-crashlog/README.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,14 @@ Build
3535

3636
To build the ``ACRN-Crashlog``, run below command under ``acrn-crashlog/``:
3737

38-
.. code-block:: console
38+
.. code-block:: none
3939
4040
$ make
4141
4242
To remove all generated files and return the folder to its clean state, use
4343
below command under ``acrn-crashlog/``:
4444

45-
.. code-block:: console
45+
.. code-block:: none
4646
4747
$ make clean
4848
@@ -51,7 +51,7 @@ Installing
5151

5252
To install the build
5353

54-
.. code-block:: console
54+
.. code-block:: none
5555
5656
$ sudo make install
5757
@@ -81,7 +81,7 @@ telemetrics-client on the system:
8181

8282
Crashlog can be retrieved with ``telem_journal`` command:
8383

84-
.. code-block:: console
84+
.. code-block:: none
8585
8686
$ telem_journal -i
8787
@@ -93,7 +93,7 @@ Crashlog can be retrieved with ``telem_journal`` command:
9393
``ACRN-Crashlog`` also provides a tool ``debugger`` to dump the specific
9494
process information:
9595

96-
.. code-block:: console
96+
.. code-block:: none
9797
9898
$ debugger <pid>
9999
@@ -106,7 +106,7 @@ Source Code
106106

107107
The source code structure:
108108

109-
.. code-block:: console
109+
.. code-block:: none
110110
111111
acrn-crashlog/
112112
├── acrnprobe

tools/acrn-crashlog/acrnprobe/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ Specify a configuration file for ``acrnprobe``. If this option is unused,
2626
``acrnprobe`` will use the configuration file located in CUSTOM CONFIGURATION
2727
PATH or INSTALLATION PATH (see `CONFIGURATION FILES`_).
2828

29-
.. code-block:: console
29+
.. code-block:: none
3030
3131
$ acrnprobe -c [configuration_path]
3232
3333
To see the version of ``acrnprobe``.
3434

35-
.. code-block:: console
35+
.. code-block:: none
3636
3737
$ acrnprobe -V
3838

tools/acrn-crashlog/usercrash/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Usage
5656
``core_pattern``. The content of ``core_pattern`` is configured as
5757
``usercrash_c`` while booting up:
5858

59-
.. code-block:: console
59+
.. code-block:: none
6060
6161
$ echo "|/usr/bin/usercrash_c %p %e %s" > /proc/sys/kernel/core_pattern
6262
@@ -67,7 +67,7 @@ event will be sent to server from client.
6767
specific process, including backtrace, stack, opened files, registers value,
6868
memory content around registers, and etc.
6969

70-
.. code-block:: console
70+
.. code-block:: none
7171
7272
$ debugger <pid>
7373

0 commit comments

Comments
 (0)