| Message ID | 20260922183249.2433345-2-twoerner@gmail.com |
|---|---|
| State | Under Review |
| Headers | show |
| Series | docs: editorial repairs to the examples | expand |
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. In any case, Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Thanks! Quentin
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
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
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(-)