Mailing-List: contact test-dev-help@httpd.apache.org; run by ezmlm
Precedence: bulk
Reply-To: test-dev@httpd.apache.org
Date: Sat, 11 Aug 2001 13:24:29 +0800 (SGT)
From: Stas Bekman <stas@stason.org>
To: <test-dev@httpd.apache.org>
Subject: tests documentation?
In-Reply-To: <20010811011133.65221.qmail@icarus.apache.org>
Message-ID: <Pine.LNX.4.33.0108111318390.14384-100000@localhost.localdomain>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII

Can we please establish some basic tests documentation rules? This will
make it much easier for those who don't spend all their time writing
tests to be able to find their way around and add new tests.

I know that nobody likes writing docs :(

It'd be nice to have at least one sentence explanation of what each
Apache::Test* module is for, at least for those that aren't obvious.

For the tests/module pairs, it'd be nice to document .t files to mention
what response handler files there are using. Especially now, where we have
perl .t files driving .c response handlers. And may be vice versa, to have
the handler point back to the corresponding .t file.

If you agree that documentation is essential, we can write the docs in a
way that makes the documentation extractable. So we can auto-generate a
document explaining the mapping of .t to .c, .pm handlers and their
explanation. This kind of map would be of immense value for people who
join the tests project, and useful for the current contributors as the
number of tests grow.

Thank you.

_____________________________________________________________________
Stas Bekman              JAm_pH     --   Just Another mod_perl Hacker
http://stason.org/       mod_perl Guide  http://perl.apache.org/guide
mailto:stas@stason.org   http://apachetoday.com http://eXtropia.com/
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/