[Buildbot-devel] setting the description field for ShellCommand

[Dobes Vandermeer]

On 11/7/05, Dobes Vandermeer <dobesv at gmail.com> wrote:
> On 11/6/05, Brian Warner <warner-buildbot at lothar.com> wrote:
> > > This lets me write steps like this in the master.cfg file:
> > >
> > > s(step.DescribedShellCommand,
> > >                 command = ["cp", "foo/bar/baz/Makefile.foo", "."],
> > >                 description = ["build", "prep"],
> > >                 descriptionDone = ["prep done"])
> >
> > So, um, did you try doing exactly this with the normal step.ShellCommand? I
> > just tried that and it seems to work just fine. I had assumed there was a bug
> > in the way it used self.__class__.parms (I can no longer remember why I
> > didn't use just self.parms), but when I went to run a test, it seems like
> > there isn't actually a bug there.
> >
> > What problem did you run into that required the custom subclass?
>
> It does look like you can set description and descriptionDone
> manually.  My changes allowed setting name instead, which is what I've
> been using, but perhaps this was just a misunderstanding of the
> documentation on my part...
>

After changing from setting name to setting description, the buildbot
status page and failure mails say things like "failed shell_1 failed
shell_2" on a failure instead of the nice name I had before, which is
a bit annoying.