Skip to contentSkip to conversation

dev-manual: explicit that devpyshell is a task

PATCH In review Michael Opdenacker 2 participants 3 messages Aug 30, 2021 – Aug 31, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dev-manual: explicit that devpyshell is a task

Without this, readers could think that "devpyshell" is a script, at least until they read the remainder of the section.

---
 documentation/dev-manual/common-tasks.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
documentation/dev-manual/common-tasks.rst +1 -1
index f3b5084436..6df1f3b791 100644
@@ -3476,7 +3476,7 @@ Similar to working within a development shell as described in the
 previous section, you can also spawn and work within an interactive
 Python development shell. When debugging certain commands or even when
 just editing packages, ``devpyshell`` can be a useful tool. When you
-invoke ``devpyshell``, all tasks up to and including
+invoke the ``devpyshell`` task, all tasks up to and including
 :ref:`ref-tasks-patch` are run for the
 specified target. Then a new terminal is opened. Additionally, key
 Python objects and code are available in the same way they are to
Signature · 1 line
2.25.1
Reviewed-by on v1 1/1
#1 lore raw

Hi Michael,

Quoted 4 lines · Michael Opdenacker

Without this, readers could think that "devpyshell" is a script, at least until they read the remainder of the section.

Thanks!
Quentin

Quoted 24 lines
---
 documentation/dev-manual/common-tasks.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
documentation/dev-manual/common-tasks.rst +1 -1
index f3b5084436..6df1f3b791 100644
@@ -3476,7 +3476,7 @@ Similar to working within a development shell as described in the
 previous section, you can also spawn and work within an interactive
 Python development shell. When debugging certain commands or even when
 just editing packages, ``devpyshell`` can be a useful tool. When you
-invoke ``devpyshell``, all tasks up to and including
+invoke the ``devpyshell`` task, all tasks up to and including
 :ref:`ref-tasks-patch` are run for the
 specified target. Then a new terminal is opened. Additionally, key
 Python objects and code are available in the same way they are to
Signature · 1 line
2.25.1
#2 lore raw

Hi Quentin,

Quoted 8 lines · Quentin Schulz

Hi Michael,

Quoted 4 lines · Michael Opdenacker

Without this, readers could think that "devpyshell" is a script, at least until they read the remainder of the section.

Thanks for the review!
Merged into master-next.

Cheers
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com