bug#37476: [PATCH] Document ert test selectors in batch mode

[Stefan Kangas <stefan@marxist.se>]

Lars Ingebrigtsen <larsi@gnus.org> writes:

> > -If ERT is not part of your Emacs distribution, you may need to use
> > +You can specify selectors to only run a subset of your tests
> > +(@pxref{Test Selectors}).  For example, the following would run all
> > +tests where the name of the test matches the string ``to-match''.
> > +
> > +@example
> > +emacs -batch -l ert -l my-tests.el \
> > +      -eval '(ert-run-tests-batch-and-exit "to-match")'
> > +@end example
>
> I guess that would be nice to have documented, but it's not a use case
> I've ever had.  Tests are usually grouped in separate files, so you'd
> usually have (as in Emacs) "make foo-tests" or whatever in your
> Makefiles.

I find that it's sometimes easier to run just one unit test from a
file, since there is less output and therefore less scrolling.  I've
had to search the web to find out how to do this before.

I'm not sure I understand the second sentence.  Package developers
might have a Makefile similar to the one Emacs core has, which allows
you to easily specify test selectors, but they might also be missing
one.

> > +If you are using a version of Emacs older than 24.1, ERT is not part
> > +of your Emacs distribution.  In this case, you may need to use
>
> The Emacs manuals usually document what's currently in Emacs, so it's a
> bit odd to be talking about Emacs 24.1 here, isn't it?  So perhaps that
> paragraph should just be removed?

I completely agree, and was simply trying to be conservative.  If
that's what we want, I'll be happy to remove it.

Thanks for reviewing the patch.

Best regards,
Stefan Kangas