Re: [naviserver-devel] Re: [naviserver-commits] naviserver/nslog nslog.c,1.1.1.1,1.2

[Zoran V. <zv...@ar...>]

On Thursday 03 March 2005 09:43, Stephen Deasey wrote:
> I've noticed some problems with this recent change.
> 
> 
> The log message doesn't say what has changed, just that something has
> changed, although the ChangeLog entry is better.  The X-Forwarded-For
> change is a bug fix and is not mentioned in either.  I thought we'd
> already agreed that non-trivial changes should have an RFE or BUG
> posted to the tracker?
> 
> 
> It's unreasonable to expect end users to examine the source code for
> documentation, so we should not clutter up the code with it.  There
> are no other source files I'm aware of which do this.
> 
> 
> The members of the Log struct have been re-arranged.  Variable
> declarations beginning a function have moved around.  Many of the
> comments have been reformatted.  Correctly formatted code has had
> braces and spacing removed, etc.  This all makes it very tricky to
> read diffs to figure out what has logically changed.

Suggestion: we should try spearate these two steps: reformatting
and actual code changes.

I quite often merge these two in one, which makes the real changes
pretty obscure. But this is really wrong. One should first cleanup
then commit with the log clearly stated that no functional code 
changes have been done. Then one should go and add real changes,
of course by trying to follow the style guidelines. The latter are
quite obvious when skimming thru the rest of the code and eventually
the Tcl code (both styles are very similar). 

And, yes. I would also preffer to make an RFE or bug report in SF
before doing the change. This is for the sole purpose of trails 
and documentation. Otherwise, we will get lost very soon.

Zoran