Re: [PATCH 2/2] t0303: resurrect commit message as test documentation

From: Jeff King <peff@peff.net>
Date: Mar 13, 2012, 21:38 UTC
Message-ID: <20120313213850.GB27752@sigill.intra.peff.net>
In-Reply-To: <20120312204340.GA10661@burratino>

On Mon, Mar 12, 2012 at 03:43:40PM -0500, Jonathan Nieder wrote:

Show 22 quoted lines

> > +# Test harness for external credential helpers
> > +#
> > +# This is a tool for authors of external helper tools to sanity-check
> > +# their helpers. If you have written the "git-credential-foo" helper,
> > +# you check it with:
> > +#
> > +# GIT_TEST_CREDENTIAL_HELPER=foo make t0303-credential-external.sh
> > +#
> > +# This assumes that your helper is capable of both storing and
> > +# retrieving credentials (some helpers may be read-only, and
> > +# they will fail these tests).
> > +#
> > +# If your helper supports time-based expiration with a
> > +# configurable timeout, you can test that feature with:
> > +#
> > +#  GIT_TEST_CREDENTIAL_HELPER_TIMEOUT="foo --timeout=1" \
> > +#      make t0303-credential-external.sh
> > +
> >  test_description='external credential helper tests'
> 
> Nice idea, but shouldn't this description be in test_description so I
> can view it by running "sh t0303-credential-external.sh --help"?

Yes, that makes sense. I didn't even know that "--help" printed out the test description; most of our descriptions are not very useful, so I never bothered. But this is the perfect thing to put in there.

-Peff