diff options
| author | Gary Oberbrunner <garyo@oberbrunner.com> | 2011-03-01 01:01:47 (GMT) |
|---|---|---|
| committer | Gary Oberbrunner <garyo@oberbrunner.com> | 2011-03-01 01:01:47 (GMT) |
| commit | efb0071db2ef9b2ef9687e1353724ed18db1ee9b (patch) | |
| tree | 88104462b1961c598053143bfacb03286dcb821b /doc | |
| parent | f6027721b125af34862d1ba7ca5ba2205a09e1fe (diff) | |
| download | SCons-efb0071db2ef9b2ef9687e1353724ed18db1ee9b.zip SCons-efb0071db2ef9b2ef9687e1353724ed18db1ee9b.tar.gz SCons-efb0071db2ef9b2ef9687e1353724ed18db1ee9b.tar.bz2 | |
New debug option --debug=duplicate to debug Variant-dir duplication
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/scons.1 | 6 | ||||
| -rw-r--r-- | doc/user/troubleshoot.in | 23 | ||||
| -rw-r--r-- | doc/user/troubleshoot.xml | 22 |
3 files changed, 51 insertions, 0 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1 index 3fa9e0c..62129ad 100644 --- a/doc/man/scons.1 +++ b/doc/man/scons.1 @@ -601,6 +601,12 @@ have been compiled with optimization files). .TP +--debug=duplicate +Print a line for each unlink/relink (or copy) of a variant file from +its source file. Includes debugging info for unlinking stale variant +files, as well as unlinking old targets before building them. + +.TP --debug=dtree A synonym for the newer .B --tree=derived diff --git a/doc/user/troubleshoot.in b/doc/user/troubleshoot.in index b0e8681..b237cbb 100644 --- a/doc/user/troubleshoot.in +++ b/doc/user/troubleshoot.in @@ -857,8 +857,31 @@ </section> + <section> + + <title>Why is a file disappearing? the --debug=duplicate Option</title> + + <para> + + When using the &Duplicate; option to create variant dirs, + sometimes you may find files not getting copied to where you + expect (or not at all), or files mysteriously disappearing. These + are usually because of a misconfiguration of some kind in the + SConstruct/SConscript, but they can be tricky to debug. The + --debug=duplicate option shows each time a variant file is + unlinked and relinked from its source (or copied, depending on + settings), and also shows a message for removing "stale" + variant-dir files that no longer have a corresponding source file. + It also prints a line for each target that's removed just before + building, since that can also be mistaken for the same thing. + + </para> + + </section> + <!-- + <section> <title>Where Are My Build Bottlenecks? the &profile; Option</title> diff --git a/doc/user/troubleshoot.xml b/doc/user/troubleshoot.xml index 586612a..c2a31b7 100644 --- a/doc/user/troubleshoot.xml +++ b/doc/user/troubleshoot.xml @@ -1275,6 +1275,28 @@ </section> + <section> + + <title>Why is a file disappearing? the --debug=duplicate Option</title> + + <para> + + When using the &Duplicate; option to create variant dirs, + sometimes you may find files not getting copied to where you + expect (or not at all), or files mysteriously disappearing. These + are usually because of a misconfiguration of some kind in the + SConstruct/SConscript, but they can be tricky to debug. The + --debug=duplicate option shows each time a variant file is + unlinked and relinked from its source (or copied, depending on + settings), and also shows a message for removing "stale" + variant-dir files that no longer have a corresponding source file. + It also prints a line for each target that's removed just before + building, since that can also be mistaken for the same thing. + + </para> + + </section> + <!-- <section> |