199235 - Modern contrib/ stuff lacks documentation

Status: RESOLVED DUPLICATE of bug 356926

(Bugzilla :: Documentation, defect, P4)

Description

[Jacob Steenhagen]

There should be a section for documenting how to use the stuff in contrib. 
Among  other things, the script introduced in bug 198458 should be documented.

Comment 1

[Dave Miller [:justdave]]

Yeah, I was going to do that as part of the checkin for that bug. :)

I have a full printout of the cvs logs for everything in that directory, and was
planning to expand the README file a bit :)

Comment 2

[Dave Miller [:justdave]]

Adding Matt Barnson, who mentioned in IRC tonight that he was working on some of
this already.

Comment 3

[Dave Miller [:justdave]]

Jake is leaving for a while (Reserve unit got called up), and we don't have a
new docs owner yet.  Anyone interested in helping out, please add
[e-mail] to your watch list in your email preferences in Bugzilla.

Comment 4

[Dave Miller [:justdave]]

Enhancements which don't currently have patches on them which are targetted at
2.18 are being retargetted to 2.20 because we're about to freeze for 2.18. 
Consideration will be taken for moving items back to 2.18 on a case-by-case
basis (but is unlikely for enhancements)

Comment 5

[Dave Miller [:justdave]]

all docs are current milestone

Comment 6

[Max Kanat-Alexander]

For what it's worth, if you add POD to any of the files in contrib/, that POD will show up automatically in the API docs.

Comment 7

[Sam Folk-Williams]

I believe this is a duplicate of 356926, which has a patch under review