Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-6721

Please document appropriate use of ups/*.cfg files

    Details

      Description

      There is no useful stack documentation I can find which covers the ups/*.cfg files used by sconsUtils. In particular:

      • sconsUtils is not listed as a documented package on the Doxygen front page.
      • Searching Doxygen pulls up some docstrings in sconsUtils which indicate where it's used, but give no indication of the appropriate usage patterns.
      • The Developer Guide page on "adding a new package to the build" makes only a passing reference to it.
      • Kian-Tat Lim points me to the template, which contains some comments. Setting aside the fact that comments in templates don't seem to be the appropriate place to store our documentation, I'm left wondering (for example):
        • Are these build or run time dependencies (the answer is build, but the documentation doesn't say that);
        • Does "scons tests" count as part of the build? That is, do I need to list packages which compilation doesn't require, but test execution does?
        • Does "pure-Python dependencies" mean "dependencies which are written purely in Python" or "packages which are only depended on in Python code"?

      Please provide a convenient reference in the Developer Guide and/or sconsUtils documentation.

        Attachments

          Container Issues

            Activity

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                swinbank John Swinbank
                Watchers:
                John Swinbank, Jonathan Sick, Tim Jenness
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Summary Panel