Re: [docs] [PATCH v2 1/8] docs: give the root prompts a preamble

[Trevor Woerner <twoerner@gmail.com>]

On Wed 2026-09-23 @ 12:17:36 PM, Quentin Schulz wrote:
> Hi Trevor,
> 
> On 9/22/26 8:32 PM, Trevor Woerner via lists.yoctoproject.org wrote:
> > 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
> 
> This file is also missing a
> 
> root@machine:~# cd /usr/src/kernel
> root@machine:/usr/src/kernel# make scripts
> 
> I'm assuming.

Good catch, thanks.

> In any case,
> 
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
> 
> Thanks!
> Quentin