Debugging the distcheck target: Difference between revisions

From OPeNDAP Documentation
⧼opendap2-jumptonavigation⧽
Line 6: Line 6:


== A directory with generated content is not cleaned ==
== A directory with generated content is not cleaned ==
When ''distcheck'' complains that a directory contains files after the various clean operations, add those files to the ''DISTCLEANFILES'' variable of the Makefile.am. Use a shell pattern to remove all of the files in a directory when the directory itself should not be removed. For example, ''DISTCLEANFILES = atconfig cache/*''
'''Symptom''': The  ''make distcheck'' target complains that a directory contains files after the various clean operations.<br/>
'''Try''':  Add the latent files to the <tt>DISTCLEANFILES</tt> variable of the <tt>Makefile.am</tt>. Use a shell pattern to remove all of the files in a directory when the directory itself should not be removed. For example, <tt>DISTCLEANFILES=atconfig cache/*</tt>

Revision as of 17:03, 23 May 2017

Here are common issues that can arise when you first run make distcheck

A file or directory does not exist

Symptom: You run the build (e.g., make check) and everything's fine, but make distcheck fails because a file or directory was not present.
Try: In the code, look for places where you used the autotools variable @srcddir@ (or @top_srcdir@ or @abs_srcdir@ or @abs_top_srcdir@) to refer a file or directory that is generated. In a regular build (e.g., make check) that will work fine since the src and build directories are one and the same. With make distcheck, not so much since the build (the generated) files are in a different directory from the source. To fix this, use @builddir@ (or the obvious variant).

A directory with generated content is not cleaned

Symptom: The make distcheck target complains that a directory contains files after the various clean operations.
Try: Add the latent files to the DISTCLEANFILES variable of the Makefile.am. Use a shell pattern to remove all of the files in a directory when the directory itself should not be removed. For example, DISTCLEANFILES=atconfig cache/*