[Fuego] [PATCH 25/30] ftc: put a fixthis for the documentation
Daniel Sangorrin
daniel.sangorrin at toshiba.co.jp
Wed Jun 6 23:55:59 UTC 2018
> -----Original Message-----
> From: Tim.Bird at sony.com [mailto:Tim.Bird at sony.com]
> Sent: Thursday, June 7, 2018 5:30 AM
> To: daniel.sangorrin at toshiba.co.jp; fuego at lists.linuxfoundation.org
> Subject: RE: [Fuego] [PATCH 25/30] ftc: put a fixthis for the documentation
>
>
>
> > -----Original Message-----
> > From: Daniel Sangorrin
> >
> > with argparse it would be automatic
> >
> > Signed-off-by: Daniel Sangorrin <daniel.sangorrin at toshiba.co.jp>
> > ---
> > engine/scripts/ftc | 6 +++++-
> > 1 file changed, 5 insertions(+), 1 deletion(-)
> >
> > diff --git a/engine/scripts/ftc b/engine/scripts/ftc
> > index bfdc3d4..d0b6a94 100755
> > --- a/engine/scripts/ftc
> > +++ b/engine/scripts/ftc
> > @@ -100,7 +100,8 @@ command_help = {
> > list for the <board> argument. e.g.
> > ftc add-jobs -b board1,board2 -t Functional.foo
> >
> > - This interface may change in the future."""),
> > + This interface may change in the future.
> > + FIXTHIS: add documentation about timeout,reboot,rebuild"""),
>
> OK - I don't like this very much. This is not a normal FIXTHIS, in
> that it's visible to end users. Most FIXTHIS comments are
> comments inside the code. This one is, IMHO, very high priority.
> Other FIXTHIS items range from low priority feature suggestions,
> to "should check this some time" items.
>
> User's shouldn't see notes about the state of the code when they
> are looking for help.
>
> Can you work on this soon? I don't want this one to go out in a
> release. I'm considering re-wording it "MUSTFIX:", and having a
> regression check for such terms in my release test.
>
> Let me know what you think.
Sorry, I'll fix this soon.
Daniel
> -- Tim
>
> >
> > "rm-jobs": ("Removes jobs from Jenkins.",
> > """Usage: ftc rm-jobs [--remove-logs]
> > <board>.<testspec>.<testtype>.<testcase>
> > @@ -239,6 +240,9 @@ would run the pre_test, pre_check, build and deploy
> > phases of the test.
> > This is useful during development of a test (ie. for testing tests).
> > Use caution running later phases of a test without their normal
> > precursors (e.g. run, without build or deploy).
> > +
> > +FIXTHIS: add documentation about timeout,reboot,rebuild,dynamic-vars
> Same issue as above.
>
> > +
> > """),
> >
> > "build-jobs": ("Build one or more jobs (to execute tests) in Jenkins.",
> > --
> > 2.7.4
>
>
> Applied - but changed to MUSTFIX.
> -- Tim
>
More information about the Fuego
mailing list