[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: How to document tags?
From: |
kj |
Subject: |
Re: How to document tags? |
Date: |
Thu, 24 Feb 2005 00:23:00 +0000 (UTC) |
User-agent: |
nn/6.6.5 |
In <address@hidden> Todd Denniston <address@hidden> writes:
>"Jim.Hyslop" wrote:
>>
>> kj wrote:
>> > Is there any good way to document (using normal, unabbreviated
>> > English prose, as opposed to cryptic tag names) the meaning of
>> > individual tags?
>> Not directly within CVS itself. Our company's guidelines require each
>> project to have a file, tags.txt, which documents the tag, when it was
>> applied, who applied it, and what it's used for. As you might guess, the
>> biggest problem is remembering to make the entries in the file.
>>
>I do the same thing here, but getting tags.txt updated is not a problem
>because all tags are applied with a script, which takes as input the
>documentation as a string and traps the rest of the who/when from the
>environment, the script first checks out a tree, then puts the data in
>tags.txt, commits tags.txt (with the documentation string as the comment),
>tags all the files in the tree including tags.txt, and finally releases the
>checkout.
Sounds like a handy script. If you don't mind posting it, it would
be much appreciated.
kj
--
NOTE: In my address everything before the first period is backwards;
and the last period, and everything after it, should be discarded.