[sldev] Re: [VIEWER] Dead code removal (Lawson English)

Ettore Pasquini ettore_pasquini at 3dconnexion.com
Tue Sep 4 18:04:51 PDT 2007


On 9/4/07 4:57 PM, "Argent Stonecutter" <secret.argent at gmail.com> wrote:

> From: Lawson English <lenglish5 at cox.net>
>> Pardon me if this sounds like a bad library design to me, unless that
>> code is definitely designeed to be "dual use" between client and
>> server
>> like common definitions and communications modules, and in that
>> case, it
>> should be factored into its own files and placed in the "common" if I
>> understand what that is for.
> 
> There's a lot of code in the client that is clearly designed to be
> used by multiple programs. There are whole modules that look just
> like common libraries that the client happens to be using.

The "clearly" part is highly subjective, depending on how much confidence  a
reader has with the code. In this case, even if you have relatively good
knowledge, we may still not know the "second reason to exist" of a
particular piece of code because we don't know its whole story. (For reasons
often discussed...)

So... As part of having better code documentation, how about just adding a
"used by" tag above the GPL header like:

    Used by: Viewer, Sim, (or whatever)

That would eliminate some doubts, at least with a per-file granularity.

-Ettore



More information about the SLDev mailing list