[darcs-devel] [issue1284] docs: improve documentation of each test

[Trent Buck]

New submission from Trent Buck <trentbuck at gmail.com>:

Currently most scripts in tests/ have no commentary at all.  They
should all have:

- a copyright declaration;
- a license declaration; and
- a concise description of the property or regression being tested.

I will extract copyright from "darcs changes".  Hopefully this will be
correct, though in some cases the patch may have been recorded by
someone who wasn't the original author, and the author field not
spoofed.

Regarding licensing, I suggest taking the stance that the tests are
implicitly licensed under "GPL (any)" or "GPL2 or higher", as COPYING
contains the GPL2 license.  Add these license declarations, then spam
the authors asking them to reply and "opt out" if they want a
different license (but discouraging it, as heterogeneity will cause
headaches).

For the third point, tests named issueNNN I can use the BTS as a
source of explanation (often just copy-and-pasting the original
message, I guess).  For other tests, I will need to look at "darcs
changes".

----------
assignedto: twb
messages: 6894
nosy: dmitry.kurochkin, kowey, simon, thorkilnaur, twb
status: unread
title: docs: improve documentation of each test

__________________________________
Darcs bug tracker <bugs at darcs.net>
<http://bugs.darcs.net/issue1284>
__________________________________