Difference between revisions of "Debugging the distcheck target"

From OPeNDAP Documentation
(Created page with "Here are common issues that can arise when you first run ''make distcheck'' == A file or directory does not exist == You run the build (e.g., ''make check'') and everything's...")
 
m (A file or directory does not exist)
Line 3: Line 3:
 
== A file or directory does not exist ==
 
== A file or directory does not exist ==
 
You run the build (e.g., ''make check'') and everything's fine, but ''distcheck'' fails because a file or directory was not present. In the code, look for places where you used the autotools variable '''@srcddir@''' (or @top_srcdir@ or @abs_srcdir@ or @sbd_top_Srcdir@) to refer a file or directory that is generated. In a regular build (e.g., ''check'') that will work fin since the src and build directories are one and the same. With ''distcheck'', not so much since the build (the generated file) are in a different directory from the source. To fix this, use '''@builddir@''' (or the obvious variant).
 
You run the build (e.g., ''make check'') and everything's fine, but ''distcheck'' fails because a file or directory was not present. In the code, look for places where you used the autotools variable '''@srcddir@''' (or @top_srcdir@ or @abs_srcdir@ or @sbd_top_Srcdir@) to refer a file or directory that is generated. In a regular build (e.g., ''check'') that will work fin since the src and build directories are one and the same. With ''distcheck'', not so much since the build (the generated file) 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 ==
 +
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/*''

Revision as of 16:42, 23 May 2017

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

1 A file or directory does not exist

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

2 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/*