Login | Register
My pages Projects Community openCollabNet
Project highlights:

29 Sep 2014: Release 2.3.4 is now available at the download page.

24 Aug 2014: Release 2.3.3 is now available at the download page.

05 July 2014: Release 2.3.2 is now available at the download page.

02 Feb 2013: Release 2.3.0 is now available at the download page.

scons
Bug Submission

You must now log in to a tigris.org account before submitting a new bug report!

Bugs should be reported at the "Enter Issue" page. Please follow the submission guidelines below to make sure your bug report contains the necessary information. A more detailed set of submission steps can be found below.

The above URL is set up for reporting a bug in SCons itself. If you are reporting a problem in some other aspect of the SCons Project (such as the documentation, or any of the web pages), you must change the Subcomponent field of the submission form to some other appropriate value.

Guidelines for a Useful Bug Report

Your bug will be much more likely to get diagnosed and fixed if you supply all the necessary information to make it easy to do so.

  • Log in to your tigris.org account before submitting a bug report

    If you do not already have a tigris.org account, register for one at http://www.tigris.org/servlets/Join.

    We no longer accept anonymous bug reports, due to spambot abuse of the open-door policy.

  • Specify the version of SCons in which you observed the problem

    This helps avoid wasted time trying to pinpoint the version, and also allows us to confirm if a later released version has already fixed your problem.

  • Provide SConscript files or other configuration that reproduce the problem

    If you can, simplify the configuration to just the minimal subset that demonstrates the problem. It's much harder to diagnose a problem if the incorrect behavor is due to one particular item out of a thousand in a large configuration.

    That said, it's most convenient if you can provide an actual configuration (set of SConscript files and/or other input files) that can be downloaded and run to demonstrate the bug. The easiest way is to attach a .tar.gz or .zip file to the bug report. Note that the tigris.org Issue Tracker doesn't let you attach a file like this when you initially submit the report. You must first create the bug report, and then attach a file to it as a separate step. See below for the detailed steps.

    If your problem is evident from a few specific SConscript lines, it's perfectly acceptable just to paste the lines into the Description field of the bug report.

  • Describe specifically the incorrect behavor you observed

    It's best if you can cut and paste the output from SCons, especially any error messages. Otherwise, Vague descriptions like, "SCons errors out," or "Product XYZ doesn't compile" are extremely difficult to diagnose, because the different installed tools on someone else's system may cause SCons to behave differently and not demonstrate your bug.

  • Describe what you expected to happen

    This isn't always obvious, especially if the bug does not involve an SCons failure or error message. Describing the behavior you expected helps speed up the diagnosis.

Steps for Submitting a Bug Report

The following guides you step-by-step through the process of submitting a new SCons bug report.

NOTE: Creating a bug report with an attached file or files (such as a .tar.gz or .zip file containing a sample configuration) is a two-step process in the tigris.org Issue Tracker. You must first create the bug report, and then attach the file(s) in a separate step, as described below.

  • Log in at tigris.org

    If you do not already have a tigris.org account, register for one at http://www.tigris.org/servlets/Join.

    We no longer accept anonymous bug reports, due to spambot abuse of the open-door policy.

  • Go to the "Enter issue" page

    By default, the "scons" subcomponent is selected; if this bug is for a different subcomponent, select that instead.

  • Specify the version of SCons in which you found the bug

  • Specify the Subcomponent (if the bug is not in SCons itself)

    The URL two steps above assumes that you're reporting a bug in the behavior of SCons itself. If you're reporting a problem in some other aspect of the SCons Project (such as the documentation, or the packaging), please change the Subcomponent field to reflect that.

  • Specify the Platform and OS

    The Platform field is less important here (SCons doesn't have many behavioral difference due to different hardware platforms) but the OS field is important.

  • Fill in a good Summary line describing the bug

    This line is what shows up in summary reports, so it should be descriptive but not too long. Avoid overly-general things like "SCons error," etc.

  • Fill in the Description field

    This is where you should go into detail about the configuration, the exact error you see, what you expected to happen, etc. When in doubt, include more information rather than less.

  • Press the "Submit issue" to submit your report

    You will now receive a Posting issue page that gives you the number of the issue you submitted.

  • If you have a .tar.gz, .zip or other file to attach:
    • Click the "Attach a file to this issue" link
    • Fill in the "File" field with the path to the file you want to upload (You can also do this through the Browse... button.)
    • Fill in the Description field
    • Click the "Submit" button