Public SourceMage Discussion List

[Andrew <afrayedknot AT thefrayedknot.armory.com>]

On Wed, Nov 24, 2004 at 10:49:32AM +0100, Benoit Papillault wrote:
> Karsten Behrmann a ?crit :
> 
> >Hrm. You talking about manpages?
> No.
> 
> >Those that I rewrote those last days and that were 2 years behind until 
> >then? ;)
> Good news :-). In which sorcery release are they available. This 
> deserves an official annoucement :-)
> 
> >Or in-code documentation, which is mostly complete and sucfficient IMHO, 
> >but if you want to volunteer...
> No.
> 
> I'm talking on documenting sorcery as a black box. For instance, I'd 
> like to know:
> 
> - does resurrect overwrite existing files or not? (The code says no, but 
> if there was a documentation that says it should, it would be a bug, 
> without a documentation, i just don't know if it is a bug, and since 
> nobody is complaining about it, nobody will think its a bug).

You know the answer, but the resurrect code is very very old, and a
product of a lot of old bugfixes that werent documented, so if you have
the time to spare from working on fixing iso bugs *ahem* and all the
other stuff you've overly enthusiastic to work on, then you're more than
welcome to try and document what the existing code does. Does this mean
I can complain to you when the documentation is unclear, or wrong? Btw
you've listed my last name in all caps on your webpage, my last name
has only one capital letter, and its the first one, please fix this error.

> 
> - does spell files have to be executable? (The code says yes, but since 
> patch applied to grimoire does not handle file rights, some files that 
> should be executable according to sorcery source code are not. Maybe its 
> a bug again, maybe not).
This is a well known fact, and i believe its documented on the wiki.

> 
> - does CONFIGURE script is run even if i use "cast -c spell"? (The code 
> says yes, ...)
no one said it wasnt...but i guess you can be overly pedantic, pedantic
documentation can be helpful, I believe this is actually documented on
the wiki as well. I strongly dislike duplicate documentation especially
when no one is around to fix it, and I dont know where it is. Theres
a vast body of documentation of sorcery on the wiki, but I dont have
time to update it, Im busy enough keeping the new things documented,
and writing the new code. When we had an active docs team most stuff
was documented, or would be updated when things changed. Perhaps you're
really just volunteering to be docs team lead? I thought you were on
the iso team?

-Andrew