source file organization
David Relson
relson at osagesoftware.com
Fri Jan 3 19:32:46 CET 2003
Greetings,
This is number 2 of my reorganization emails :-)
In my main bogofilter (cvs) directory there are approx 150 files. 20+ are
documentation files and 90+ are source code (*.h, *.c, *.l).
In my 0.9.1.2 release directory, there are 101 files, with 53 source files,
and the same 20+ documentation files. Obviously the number of files in the
project is increasing and most of them are source code.
The figures above are _before_ a build. After running "make check", the
count in my cvs directory increases by 65 (of which 54 are *.o files).
This is a large number of files and makes it hard to see/find whatever else
is in this directory (besides source code and generated files).
The documentation reorganization (if it happens) will move many of the 20+
files to the "doc" subdirectory. That will clean things up a bit.
I've been thinking of creating a "src" directory and moving the 90+ source
files to it. The generated *.o and executable files would end up there, as
well.
Doing this will make it much easier to see the project structure and find
the files of interest. Those're the advantages.
The known disadvantage is cvs. cvs doesn't like moving files. It has add
and delete capabilities, but no move. Reorganizing would involve deleting
all source code files, creating the directory, and adding all source code
files to that directory. The cvs version numbers would change and the cvs
history would be lost. We can preserve the history with a snapshot of the
cvs repository and via the cvs log command (which currently generates
18,060 lines of text totally 663,163 bytes). Doing this would (forever)
separate old version info from the source tree (except as retained in the
snapshot).
Obviously, I'm in favor of the reorganization, else I wouldn't suggest
it. Doing it sooner, rather than later, would be a good thing. As we near
the release of version 1.0, it seems like a logical moment in time for such
a change.
All in favor say "Yay". All opposed say "Nay".
Cheers,
David
More information about the Bogofilter
mailing list