mbox

[0/1] bitbake: ncurses version of taskexp.py

Message ID cover.1653448549.git.David.Reyna@windriver.com
State Not Applicable, archived
Headers show

Pull-request

git://push.yoctoproject.org/poky-contrib dreyna/bitbake/ncurses_taskexp_14814

Message

Reyna, David May 25, 2022, 6:24 a.m. UTC
From: David Reyna <David.Reyna@windriver.com>


Added since demo at YP Summit:
 * Protection against window resizing
 * Line art (with ASCII line art as backup)
 * Additional internal documentation
 * Tested against misspelled recipe errors


The following changes since commit 13d70e57f8693e506aada946ae9b2e0997e4c5f0:

  migration guides: release notes for 3.4.3 and 3.4.4 (2022-05-24 13:58:47 +0100)

are available in the Git repository at:

  git://push.yoctoproject.org/poky-contrib dreyna/bitbake/ncurses_taskexp_14814

David Reyna (1):
  bitbake: ncurses version of taskexp.py

 lib/bb/ui/taskexp_cli.py | 1302 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 1302 insertions(+)
 create mode 100755 bitbake/lib/bb/ui/taskexp_cli.py

Comments

Peter Kjellerstedt May 25, 2022, 6:53 p.m. UTC | #1
> -----Original Message-----
> From: bitbake-devel@lists.openembedded.org <bitbake-devel@lists.openembedded.org> On Behalf Of Reyna, David
> Sent: den 25 maj 2022 08:25
> To: bitbake-devel@lists.openembedded.org
> Cc: David Reyna <David.Reyna@windriver.com>
> Subject: [bitbake-devel] [PATCH 0/1] bitbake: ncurses version of taskexp.py
> 
> From: David Reyna <David.Reyna@windriver.com>
> 
> 
> Added since demo at YP Summit:
>  * Protection against window resizing
>  * Line art (with ASCII line art as backup)
>  * Additional internal documentation
>  * Tested against misspelled recipe errors
> 
> 
> The following changes since commit 13d70e57f8693e506aada946ae9b2e0997e4c5f0:
> 
>   migration guides: release notes for 3.4.3 and 3.4.4 (2022-05-24 13:58:47 +0100)
> 
> are available in the Git repository at:
> 
>   git://push.yoctoproject.org/poky-contrib dreyna/bitbake/ncurses_taskexp_14814
> 
> David Reyna (1):
>   bitbake: ncurses version of taskexp.py
> 
>  lib/bb/ui/taskexp_cli.py | 1302 ++++++++++++++++++++++++++++++++++++++
>  1 file changed, 1302 insertions(+)
>  create mode 100755 bitbake/lib/bb/ui/taskexp_cli.py
> 
> --
> 2.35.1

May I suggest using a name that does not include "cli", because as I see it, 
this has nothing to do with a command line interface, rather it is a text 
based UI. More appropriate may be something like "tty" or "ncurses". Or to 
complement "knotty", you could call it "tetty". ;) (Though I guess it may be 
harder to remember what that does compared to "taskexp_tty".)

//Peter
Reyna, David May 25, 2022, 7:37 p.m. UTC | #2
Hi,

> "May I suggest using a name that does not include "cli", because as I see it, ... may be something like 'tty' or 'ncurses'."

I am open to a name change.
 
My take:
   taskexp_tty : my preference
   taskexp_nc : short, but not memorable
   taskexp_ncurses : long name, but accurate

David

-----Original Message-----
From: Peter Kjellerstedt <peter.kjellerstedt@axis.com> 
Sent: Wednesday, May 25, 2022 11:53 AM
To: Reyna, David <david.reyna@windriver.com>; bitbake-devel@lists.openembedded.org
Subject: RE: [bitbake-devel] [PATCH 0/1] bitbake: ncurses version of taskexp.py

> -----Original Message-----
> From: bitbake-devel@lists.openembedded.org <bitbake-devel@lists.openembedded.org> On Behalf Of Reyna, David
> Sent: den 25 maj 2022 08:25
> To: bitbake-devel@lists.openembedded.org
> Cc: David Reyna <David.Reyna@windriver.com>
> Subject: [bitbake-devel] [PATCH 0/1] bitbake: ncurses version of taskexp.py
> 
> From: David Reyna <David.Reyna@windriver.com>
> 
> 
> Added since demo at YP Summit:
>  * Protection against window resizing
>  * Line art (with ASCII line art as backup)
>  * Additional internal documentation
>  * Tested against misspelled recipe errors
> 
> 
> The following changes since commit 13d70e57f8693e506aada946ae9b2e0997e4c5f0:
> 
>   migration guides: release notes for 3.4.3 and 3.4.4 (2022-05-24 13:58:47 +0100)
> 
> are available in the Git repository at:
> 
>   git://push.yoctoproject.org/poky-contrib dreyna/bitbake/ncurses_taskexp_14814
> 
> David Reyna (1):
>   bitbake: ncurses version of taskexp.py
> 
>  lib/bb/ui/taskexp_cli.py | 1302 ++++++++++++++++++++++++++++++++++++++
>  1 file changed, 1302 insertions(+)
>  create mode 100755 bitbake/lib/bb/ui/taskexp_cli.py
> 
> --
> 2.35.1

May I suggest using a name that does not include "cli", because as I see it, 
this has nothing to do with a command line interface, rather it is a text 
based UI. More appropriate may be something like "tty" or "ncurses". Or to 
complement "knotty", you could call it "tetty". ;) (Though I guess it may be 
harder to remember what that does compared to "taskexp_tty".)

//Peter
Richard Purdie May 27, 2022, 4:32 p.m. UTC | #3
On Wed, 2022-05-25 at 19:37 +0000, Reyna, David wrote:
> Hi,
> 
> > "May I suggest using a name that does not include "cli", because as I see it, ... may be something like 'tty' or 'ncurses'."
> 
> I am open to a name change.
>  
> My take:
>    taskexp_tty : my preference

FWIW that seems fine to me.

I've been hoping to find some time to do a more detailed review of the
code but haven't got there yet. It is great to see this development
though.

My biggest worry is about maintenance and testing as we don't have any
tests covering this.

Cheers,

Richard
Reyna, David May 27, 2022, 8:34 p.m. UTC | #4
> My biggest worry is about maintenance and testing as we don't have any tests covering this.

I will look at including a type of an "expect" self-test, where we could pass a text file (via an environment variable) of key commands and resulting display confirmations.

For me, the scope of potential maintenance issues appear to be:
   (a) a change in the bitbake metadata for the dependencies, 
   (b) unexpected content in that metadata for an unusual recipe,
   (c) hosts that do not render the ncurses as expected

David

-----Original Message-----
From: richard.purdie@linuxfoundation.org <richard.purdie@linuxfoundation.org> 
Sent: Friday, May 27, 2022 9:32 AM
To: Reyna, David <david.reyna@windriver.com>; Peter Kjellerstedt <peter.kjellerstedt@axis.com>; bitbake-devel@lists.openembedded.org
Subject: Re: [bitbake-devel] [PATCH 0/1] bitbake: ncurses version of taskexp.py

On Wed, 2022-05-25 at 19:37 +0000, Reyna, David wrote:
> Hi,
> 
> > "May I suggest using a name that does not include "cli", because as I see it, ... may be something like 'tty' or 'ncurses'."
> 
> I am open to a name change.
>  
> My take:
>    taskexp_tty : my preference

FWIW that seems fine to me.

I've been hoping to find some time to do a more detailed review of the
code but haven't got there yet. It is great to see this development
though.

My biggest worry is about maintenance and testing as we don't have any
tests covering this.

Cheers,

Richard
Richard Purdie May 27, 2022, 11:02 p.m. UTC | #5
On Fri, 2022-05-27 at 20:34 +0000, Reyna, David wrote:
> > My biggest worry is about maintenance and testing as we don't have
> > any tests covering this.
> 
> I will look at including a type of an "expect" self-test, where we
> could pass a text file (via an environment variable) of key commands
> and resulting display confirmations.
> 
> For me, the scope of potential maintenance issues appear to be:
>    (a) a change in the bitbake metadata for the dependencies, 
>    (b) unexpected content in that metadata for an unusual recipe,
>    (c) hosts that do not render the ncurses as expected

Yes, it doesn't need to be too complicated, as long as we have some
test exercising the UI, I'm much happier than no testing at all! :)

I know we're going to have to make changes to the UI/server API at some
point so I don't want to this to break and not be noticed.

Cheers,

Richard