From: Trevor Woerner <twoerner@gmail.com>
To: docs@lists.yoctoproject.org
Subject: [PATCH v2 1/8] docs: give the root prompts a preamble
Date: Tue, 22 Sep 2026 14:32:42 -0400 [thread overview]
Message-ID: <20260922183249.2433345-2-twoerner@gmail.com> (raw)
In-Reply-To: <20260922183249.2433345-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)
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
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 | 4 ++--
documentation/profile-manual/usage.rst | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index 2a65055e2a44..fe2e42265f9f 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
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
next prev parent reply other threads:[~2026-09-22 18:33 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-22 18:32 [PATCH v2 0/8] docs: editorial repairs to the examples Trevor Woerner
2026-09-22 18:32 ` Trevor Woerner [this message]
2026-09-23 10:17 ` [docs] [PATCH v2 1/8] docs: give the root prompts a preamble Quentin Schulz
2026-09-24 16:00 ` Trevor Woerner
2026-09-22 18:32 ` [PATCH v2 2/8] docs: copy only the command from a console block Trevor Woerner
2026-09-23 10:41 ` [docs] " Quentin Schulz
2026-09-23 10:43 ` Quentin Schulz
2026-09-22 18:32 ` [PATCH v2 3/8] docs: show a prompt on commands the reader is meant to type Trevor Woerner
2026-09-23 10:49 ` [docs] " Quentin Schulz
2026-09-24 15:59 ` Trevor Woerner
2026-09-22 18:32 ` [PATCH v2 4/8] docs: write an elided passage as a comment Trevor Woerner
2026-09-23 10:50 ` [docs] " Quentin Schulz
2026-09-22 18:32 ` [PATCH v2 5/8] docs: mark the placeholders in examples Trevor Woerner
2026-09-23 10:57 ` [docs] " Quentin Schulz
2026-09-24 15:58 ` Trevor Woerner
2026-09-22 18:32 ` [PATCH v2 6/8] docs: remove real accounts from the examples Trevor Woerner
2026-09-23 11:02 ` [docs] " Quentin Schulz
2026-09-24 15:55 ` Trevor Woerner
2026-09-22 18:32 ` [PATCH v2 7/8] kernel-dev: give each example block one thing to hold Trevor Woerner
2026-09-23 11:05 ` [docs] " Quentin Schulz
2026-09-22 18:32 ` [PATCH v2 8/8] ref-manual: put the ARCHIVER_MODE comments on their own lines Trevor Woerner
2026-09-23 11:09 ` [docs] " Quentin Schulz
2026-09-24 15:55 ` 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=20260922183249.2433345-2-twoerner@gmail.com \
--to=twoerner@gmail.com \
--cc=docs@lists.yoctoproject.org \
/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