[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
27.1.3 Living with CVS in Autoconfiscated projects
There are basically two clans amongst maintainers: those who keep all distributed files under CVS, including generated files, and those who keep generated files out of CVS.
All files in CVS
- The CVS repository contains all distributed files so you know exactly what is distributed, and you can checkout any prior version entirely.
- Maintainers can see how generated files evolve (for instance, you can see what happens to your ‘Makefile.in’s when you upgrade Automake and make sure they look OK).
- Users do not need the autotools to build a checkout of the project, it works just like a released tarball.
-
If users use
cvs update
to update their copy, instead ofcvs checkout
to fetch a fresh one, timestamps will be inaccurate. Some rebuild rules will be triggered and attempt to run developer tools such asautoconf
orautomake
.Actually, calls to such tools are all wrapped into a call to the
missing
script discussed later (see sectionmissing
andAM_MAINTAINER_MODE
).missing
will take care of fixing the timestamps when these tools are not installed, so that the build can continue. -
In distributed development, developers are likely to have different
version of the maintainer tools installed. In this case rebuilds
triggered by timestamp lossage will lead to spurious changes
to generated files. There are several solutions to this:
- All developers should use the same versions, so that the rebuilt files are identical to files in CVS. (This starts to be difficult when each project you work on uses different versions.)
- Or people use a script to fix the timestamp after a checkout (the GCC folks have such a script).
-
Or ‘configure.ac’ uses
AM_MAINTAINER_MODE
, which will disable all these rebuild rules by default. This is further discussed inmissing
andAM_MAINTAINER_MODE
.
-
Although we focused on spurious rebuilds, the converse can also
happen. CVS's timestamp handling can also let you think an
out-of-date file is up-to-date.
For instance, suppose a developer has modified ‘Makefile.am’ and has rebuilt ‘Makefile.in’. He then decide to do a last-minute change to ‘Makefile.am’ right before checking in both files (without rebuilding ‘Makefile.in’ to account for the change).
This last change to ‘Makefile.am’ make the copy of ‘Makefile.in’ out-of-date. Since CVS processes files alphabetically, when another developer ‘cvs update’ his or her tree, ‘Makefile.in’ will happen to be newer than ‘Makefile.am’. This other developer will not see ‘Makefile.in’ is out-of-date.
Generated files out of CVS
One way to get CVS and make
working peacefully is to never
store generated files in CVS, i.e., do not CVS-control files that
are ‘Makefile’ targets (also called derived files).
This way developers are not annoyed by changes to generated files. It does not matter if they all have different versions (assuming they are compatible, of course). And finally, timestamps are not lost, changes to sources files can't be missed as in the ‘Makefile.am’/‘Makefile.in’ example discussed earlier.
The drawback is that the CVS repository is not an exact copy of what is distributed and that users now need to install various development tools (maybe even specific versions) before they can build a checkout. But, after all, CVS's job is versioning, not distribution.
Allowing developers to use different versions of their tools can also hide bugs during distributed development. Indeed, developers will be using (hence testing) their own generated files, instead of the generated files that will be released actually. The developer who prepares the tarball might be using a version of the tool that produces bogus output (for instance a non-portable C file), something other developers could have noticed if they weren't using their own versions of this tool.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |