darcs

Issue 1284 improve documentation of each test

Title improve documentation of each test
Priority wishlist Status given-up
Milestone Resolved in
Superseder Nosy List darcs-devel, dmitry.kurochkin, jaredj, kowey, thorkilnaur, twb
Assigned To
Topics Devel, Documentation, ProbablyEasy

Created on 2008-12-26.13:22:01 by twb, last changed 2017-07-30.23:43:46 by gh.

Messages
msg6894 (view) Author: twb Date: 2008-12-26.13:21:56
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".
msg6981 (view) Author: thorkilnaur Date: 2009-01-05.14:26:12
Thanks, Trent, for these suggestions. I see that you are presently assigned to 
this issue, but you may not intend to do all of this work by yourself. In any 
case, something that I believe would be extremely useful would be if you could 
take a single existing test (or a few, if more convenient) and change it (or them) 
to be in accordance with your suggestions, copyright declaration, licence, 
description and everything. This could then be used by others as a valuable source 
when other tests are being modified or new ones created. Once a few examples of 
tests exist, I presume that the next steps would be documenting the new 
requirements and then making everybody aware of these requirements.

Thanks and best regards
Thorkil
msg6995 (view) Author: twb Date: 2009-01-06.00:29:30
I intend to get some examples done next weekend.
msg7034 (view) Author: twb Date: 2009-01-11.11:17:21
As Thorkil says, this is one of those tedious drudge jobs.
If *you*, dear reader, could find the time to polish even *one* test,
it would be very much appreciated.

There is a patch in the main repo called "Example for issue1284." which
you can use as a reference.
msg10463 (view) Author: kowey Date: 2010-03-23.17:50:03
No changes, moving to back of maintenance queue.

Note that this could an hlint-style task for getting starting with the
basic mechanics of submitting patches to darcs.net
History
Date User Action Args
2008-12-26 13:22:01twbcreate
2009-01-05 14:26:19thorkilnaursetpriority: wishlist
status: unread -> needs-reproduction
topic: + X_DeprecatedTopic_Testing
messages: + msg6981
nosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
2009-01-06 00:29:32twbsetnosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
messages: + msg6995
2009-01-11 10:40:11twbsetassignedto: twb ->
nosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
2009-01-11 10:51:50twbsettopic: + ProbablyEasy
nosy: + jaredj
2009-01-11 11:17:24twbsetnosy: kowey, simon, twb, thorkilnaur, jaredj, dmitry.kurochkin
messages: + msg7034
2009-08-08 10:01:39koweysettopic: + Documentation
nosy: kowey, simon, twb, thorkilnaur, jaredj, dmitry.kurochkin
2009-08-10 01:50:04twbsetnosy: kowey, simon, twb, thorkilnaur, jaredj, dmitry.kurochkin
2009-08-10 01:51:58twbsetnosy: kowey, simon, twb, thorkilnaur, jaredj, dmitry.kurochkin
title: docs: improve documentation of each test -> improve documentation of each test
2009-08-10 16:18:47koweysettopic: + Devel, - X_DeprecatedTopic_Testing
nosy: kowey, simon, twb, thorkilnaur, jaredj, dmitry.kurochkin
2009-08-10 17:40:43koweysetstatus: needs-reproduction -> needs-implementation
nosy: kowey, simon, twb, thorkilnaur, jaredj, dmitry.kurochkin
2009-08-25 17:36:58adminsetnosy: + darcs-devel, - simon
2009-08-27 14:22:06adminsetnosy: kowey, darcs-devel, twb, thorkilnaur, jaredj, dmitry.kurochkin
2010-03-23 17:50:14koweysetmessages: + msg10463
2017-07-30 23:43:46ghsetstatus: needs-implementation -> given-up