Re: [docs] [PATCH v2 3/8] docs: show a prompt on commands the reader is meant to type

[Trevor Woerner <twoerner@gmail.com>]

On Wed 2026-09-23 @ 12:49:12 PM, Quentin Schulz wrote:
> Hi Trevor,
> 
> On 9/22/26 8:32 PM, Trevor Woerner via lists.yoctoproject.org wrote:
> > Most command blocks in the manuals start their lines with "$", but a
> > scattering of them do not, and those read as a file listing rather than
> > as something to run. Give them the prompt the surrounding pages already
> > use.
> > 
> > Transcripts take a prompt on their opening line alone. Two things that
> > matter only once a line is a command go with that: a bare "$" at the end,
> > the prompt returning after the command finished, and a trailing "\" on a
> > Windows path, which a shell reads as a continuation into the output.
> > 
> > AI-Generated: codex/claude-opus 5 (xhigh)
> > Signed-off-by: Trevor Woerner <twoerner@gmail.com>
> > ---
> [...]
> > diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
> > index c7d0fe3dab8d..73b7d9501ae4 100644
> > --- a/documentation/dev-manual/start.rst
> > +++ b/documentation/dev-manual/start.rst
> > @@ -423,7 +423,7 @@ your Yocto Project build host:
> >         replace the PackageFamilyName and your user on the following path
> >         to find your VHDX file::
> > -         ls C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\
> > +         C:\WINDOWS\system32> ls C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState
> >            Mode                 LastWriteTime         Length Name
> >            -a----         3/14/2020   9:52 PM    57418973184 ext4.vhdx
> > diff --git a/documentation/dev-manual/wayland.rst b/documentation/dev-manual/wayland.rst
> > index 5e333b6265f4..3e1280943bf9 100644
> > --- a/documentation/dev-manual/wayland.rst
> > +++ b/documentation/dev-manual/wayland.rst
> > @@ -80,9 +80,9 @@ the CLI, you need to do the following after your image is built:
> >   #. Run these commands to export ``XDG_RUNTIME_DIR``::
> > -      mkdir -p /tmp/$USER-weston
> > -      chmod 0700 /tmp/$USER-weston
> > -      export XDG_RUNTIME_DIR=/tmp/$USER-weston
> > +      $ mkdir -p /tmp/$USER-weston
> > +      $ chmod 0700 /tmp/$USER-weston
> > +      $ export XDG_RUNTIME_DIR=/tmp/$USER-weston
> 
> This is to be run on the target as far as I could tell, do we also plan on
> using $ without a user@host:path$ for target commands as well as the ones
> the user is supposed to run on the build machine?

I like the preamble; i'll change it.

> >   #. Launch Weston in the shell::
> 
> Right under this context, there's a command to run which doesn't have the
> prompt and needs one.

Good catch, thanks.

> Cheers,
> Quentin