Yocto Project Documentation
 help / color / mirror / Atom feed
From: Trevor Woerner <twoerner@gmail.com>
To: docs@lists.yoctoproject.org
Cc: Quentin Schulz <quentin.schulz@cherry.de>
Subject: [PATCH v3 01/10] docs: give the root prompts a preamble
Date: Thu, 24 Sep 2026 13:28:44 -0400	[thread overview]
Message-ID: <20260924172853.2665062-2-twoerner@gmail.com> (raw)
In-Reply-To: <20260924172853.2665062-1-twoerner@gmail.com>

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 --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
-- 
2.50.0.173.g8b6f19ccfc3a



  reply	other threads:[~2026-09-24 17:29 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-24 17:28 [PATCH v3 00/10] docs: editorial repairs to the examples Trevor Woerner
2026-09-24 17:28 ` Trevor Woerner [this message]
2026-09-24 17:28 ` [PATCH v3 02/10] docs: copy only the command from a console block Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 03/10] docs: show a prompt on commands the reader is meant to type Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 04/10] docs: write an elided passage as a comment Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 05/10] docs: mark the placeholders in examples Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 06/10] docs: remove real accounts from the examples Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 07/10] kernel-dev: give each example block one thing to hold Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 08/10] ref-manual: put the ARCHIVER_MODE comments on their own lines Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 09/10] ref-manual: drop "partition" as a wic kickstart command Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 10/10] dev-manual: indent a list continuation so the code block ends Trevor Woerner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260924172853.2665062-2-twoerner@gmail.com \
    --to=twoerner@gmail.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=quentin.schulz@cherry.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox