Re: [AD] Documentation update

[Hein Zelle <hein@xxxxxxxxxx>]

Eric Botcazou wrote:

> The patch is mostly ok, but I would avoid to "hardcode" in the docs the
> hardcoded value of the code because of the risk of a future discrepancy.

I disagree. If there's a hardcoded limit to the stringlength of
a certain function, it's important to know what it is. If it's bad
enough that we have to place a warning in the documentation, we should
definitely list the actual length limit of the string. Otherwise a
programmer has to dive into the allegro source to find out, or
worse, use trial and error to find out what the limit is and hope that
the program stops nicely when it is exceeded instead of running on
with corrupted memory. (I assume there's an assert on exceeding the
stringlength?) 

I suggest putting the limit in the documentation, and just making a
note for the allegro developers (somewhere in the comments of the
function or so) that the docs have to be updated when that limit
changes.

Hein Zelle

>-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-< 
 Unix is user friendly. It's just very particular about who 
 it's friends are.

 Hein Zelle                     hein@xxxxxxxxxx
	                        http://www.icce.rug.nl/~hein
>-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-<