Re: [Phpwiki-talk] cvs log tag

[Jeff D. <da...@da...>]

On Sat, 28 Dec 2002 17:43:38 -0500 (EST)
Steve Wainstead <sw...@pa...> wrote:

> 
> I'm thinking of adding a block to the bottoms of all files in the form:
> 
> <?
> // $Log$
> ?>
> 
> What this would do is include the cvs log message every time a file is
> committed. I've found from work in the Real World that when a project is
> moved to a new cvs server, all the messages are lost.

... 

> If anyone objects please let me know. Below is a much longer explanation
> from the red bean cvs book.


... I'm catching up on mail ...

My feelings on this:

  o This is going to make the PhpWiki source bigger than it already is!
    It's already very big.  The .php files gets loaded/parsed every time
    a page is viewed --- though I doubt the log comments contribute much
    to the load time, they don't help either.

  o In other projects, I've always found a global ChangeLog to be
    much more useful.  I personally prefer the GNU-style, manually
    generated ChangeLog --- since then the whole log is tailored to
    be human readable.  One simply has to grep the file to find notes
    of interest.  (Of course, all the developers have update the
    ChangeLog, or else...)  An example would be:

====
 2003-02-20  Geoffrey T. Dairiki  <da...@da...>

	Have implemented the ability to cache marked up page text.
	(Had this been a real ChangeLog, I should have expounded
	a bit more here...)

	* lib/CachedMarkup.php: New file.
	* lib/main.php(main): Query-arg hook 'nocache' to disable markup cache.
	Use 'nocache=1' to disable reading the cache, 'nocache=purge'
	to clear the cache for the requested page.
	* lib/BlockParser.php: Changes for cached markup.
	Tweaks of list tightness logic.
 	* lib/display.php: Minor fixes for new cached markup.
	* lib/loadsave.php: ditto
	* lib/XmlRpcServer.php: ditto
	* lib/plugin/RecentChanges.php: ditto
	* lib/plugin/IncludePage.php: ditto
	* lib/plugin/UnfoldSubpages.php: ditto
	* lib/plugin/SiteMap.php: ditto
	* lib/plugin/OldStyleTable.php: ditto 


	* lib/stdlib.php(LinkBracketLinks): Moved to InlineParser.
	* lib/InlineParser.php: see above

	New class DebugTimer to help in execution profiling.
	* lib/main.php: Moved debug timing to prepend.php
	* lib/prepend.php(DebugTimer): New class.
	* lib/plugin/AllPages.php: Use DebugTimer for timing.
	* lib/plugin/AllUsers.php: ditto
	* themes/default/templates/debug.tmpl: ditto
====

    Using a manually generated global changelog like this makes
    working off-line on large changes easier.  Suppose I spend a
    couple days/week/months adding some big new feature to PhpWiki.
    When I go to check my changes in to CVS, I find I've touched
    nearly all of the files in the lib/ subdirectory.

    It's a big pain to check these in one at a time, and come up with
    diff each one to come up with useful CVS log entries for each one,
    so I'm likely to check them all in at once with some message like:
    "Big Change!  Added new XXX feature."

    If I'd just been keeping my local copy of ChangeLog up-to-date
    as I hacked, and if there were a global ChangeLog in CVS, all
    I have to do is merge the two and then the global ChangeLog is again
    meaningful...


Anyhow, my personal vote would be: no $Log$ in individual source files.
Move over to (enforced by public flogging) use of a GNU-style
global ChangeLog.