diff mbox series

[v3,01/10] docs: give the root prompts a preamble

Message ID 20260924172853.2665062-2-twoerner@gmail.com
State New
Headers show
Series docs: editorial repairs to the examples | expand

Commit Message

Trevor Woerner Sept. 24, 2026, 5:28 p.m. UTC 
A bare "#" starting a line is a root prompt, a comment, and a line of
program output all at once, and nothing can tell them apart. Most root
prompts in the manuals already carry a preamble naming the machine, and
the stragglers are what make the distinction unreliable.

Add the preamble the others already use: the machine the surrounding
steps name, or a generic "machine" where they name none.

AI-Generated: codex/claude-opus 5 (xhigh)
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
changes in v3:
- the kernel-dev "make scripts" block is prompted too, with its working
  directory in the second prompt

changes in v2:
- rebased on master-next
- the SystemTap example uses a generic root@machine prompt; the two
  kernel-dev ones keep qemux86, which the surrounding steps name
---
 documentation/kernel-dev/common.rst    | 8 ++++----
 documentation/profile-manual/usage.rst | 2 +-
 2 files changed, 5 insertions(+), 5 deletions(-)
diff mbox series

Patch

diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index 2a65055e2a44..65bd3d0d1f46 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -722,7 +722,7 @@  the ":ref:`kernel-dev/common:getting ready to develop using ``devtool```" Sectio
 
       .. code-block:: none
 
-         # dmesg | less
+         root@qemux86:~# dmesg | less
 
       You should see
       the results of your ``printk`` statements as part of the output
@@ -878,7 +878,7 @@  Section.
 
    .. code-block:: none
 
-      # dmesg | less
+      root@qemux86:~# dmesg | less
 
    You should see the results of your
    ``printk`` statements as part of the output when you scroll down the
@@ -1554,8 +1554,8 @@  directory. Next, ``make`` the scripts:
 
 .. code-block:: none
 
-   # cd /usr/src/kernel
-   # make scripts
+   root@machine:~# cd /usr/src/kernel
+   root@machine:/usr/src/kernel# make scripts
 
 Because all SDK image recipes include ``dev-pkgs``, the
 ``kernel-dev`` packages will be installed as part of the SDK image and
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst
index dc34fa36c487..4efaa6d10fce 100644
--- a/documentation/profile-manual/usage.rst
+++ b/documentation/profile-manual/usage.rst
@@ -1801,7 +1801,7 @@  probe, you'd just install SystemTap on the system you want to probe,
 and directly run the probe on that system e.g. assuming the name of the
 file containing the above text is ``trace_open.stp``::
 
-   # stap trace_open.stp
+   root@machine:~# stap trace_open.stp
 
 What SystemTap does under the covers to run this probe is 1) parse and
 convert the probe to an equivalent "C" form, 2) compile the "C" form