[PATCH] dev-manual: explicit that devpyshell is a task

[PATCH] dev-manual: explicit that devpyshell is a task

[Michael Opdenacker]

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

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/dev-manual/common-tasks.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index f3b5084436..6df1f3b791 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -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
-- 
2.25.1

Re: [docs] [PATCH] dev-manual: explicit that devpyshell is a task

[Quentin Schulz]

Hi Michael,

On Mon, Aug 30, 2021 at 04:17:50PM +0200, Michael Opdenacker wrote:
> Without this, readers could think that "devpyshell" is a script,
> at least until they read the remainder of the section.
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>

Reviewed-by: Quentin Schulz <foss@0leil.net>

Thanks!
Quentin

> ---
>  documentation/dev-manual/common-tasks.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index f3b5084436..6df1f3b791 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -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
> -- 
> 2.25.1
> 

> 
> 
> 

Re: [docs] [PATCH] dev-manual: explicit that devpyshell is a task

[Michael Opdenacker]

Hi Quentin,

On 8/31/21 10:12 AM, Quentin Schulz wrote:
> Hi Michael,
>
> On Mon, Aug 30, 2021 at 04:17:50PM +0200, Michael Opdenacker wrote:
>> Without this, readers could think that "devpyshell" is a script,
>> at least until they read the remainder of the section.
>>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> Reviewed-by: Quentin Schulz <foss@0leil.net>


Thanks for the review!
Merged into master-next.

Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com