26.6. Where is SCons Blowing Up? the --debug=stacktrace Option

In general, SCons tries to keep its error messages short and informative. That means we usually try to avoid showing the stack traces that are familiar to experienced Python programmers, since they usually contain much more information than is useful to most people.

For example, the following SConstruct file:


         Program('prog.c')
    

Generates the following error if the prog.c file does not exist:


      % scons -Q
      scons: *** Source `prog.c' not found, needed by target `prog.o'.  Stop.
    

In this case, the error is pretty obvious. But if it weren't, and you wanted to try to get more information about the error, the --debug=stacktrace option would show you exactly where in the SCons source code the problem occurs:


      % scons -Q --debug=stacktrace
      scons: *** Source `prog.c' not found, needed by target `prog.o'.  Stop.
      scons: internal stack trace:
        File "bootstrap/src/engine/SCons/Job.py", line 131, in start
        File "bootstrap/src/engine/SCons/Script/Main.py", line 169, in prepare
        File "bootstrap/src/engine/SCons/Taskmaster.py", line 169, in prepare
        File "bootstrap/src/engine/SCons/Node/FS.py", line 2551, in prepare
        File "bootstrap/src/engine/SCons/Node/__init__.py", line 349, in prepare
    

Of course, if you do need to dive into the SCons source code, we'd like to know if, or how, the error messages or troubleshooting options could have been improved to avoid that. Not everyone has the necessary time or Python skill to dive into the source code, and we'd like to improve SCons for those people as well...