[Lunar-commits] <moonbase> fbv: new module for fbterm background support

[Auke Kok]

On 07/07/2011 11:28 PM, wookietreiber wrote:
> hi
>
> 1) build fails with default_config, because its no standard autoconf created
> configure, e.g. crashes with --build=$BUILD
>
> 2) because the module is relatively old and does not compile with current
> giflib, I haven't tried libungif because its kind of deprecated. without
> gif support it does just fine for now, if someone figures out a patch -- fine,
> but I hadn't had the time
>

1) please don't top post ;)

2) your reasons are totally fine. However, when you write code like 
this, I'm assuming that you DID NOT have those reasons. Why? Because I 
cannot read your mind, and you did not communicate this reasoning out to 
other developers.

The solution to the problem is to *write comments* in your code that 
explain *why* you deviate. A deviation without commenting is ambiguous. 
The comment explains to us that you thought about the problem and made a 
decision in a certain way to deviate.

- Bad comments explain the obvious ("# run configure script")
- Good comments explain the deviation from the obvious (omitting basic 
options)
- Good comments explain the unobvious. (e.g. sed+awk jedi tricks)

So, for future reference, in a perfect world, the BUILD would have 
looked something like:

(

   # disable libungif - broken
   OPTS+=" --disable-libungif"

   # configure barfs on --build stuff
   ./configure --prefix=....

etc.

Auke