Bug 1385539 - Re-add accidentally deleted documentation of mozbuild.configure.ConfigureSandbox.include_file; r?glandium draft
authorTom Prince <mozilla@hocat.ca>
Sat, 29 Jul 2017 00:31:17 -0600
changeset 620583 4d21454f68aa15f25609afef497893a2d06a2018
parent 617946 ec666e910442ae55686160c1bd0c93b00a08dead
child 640746 c99e28024924310e9582b77722ab77ca94b2e108
push id72090
push userbmo:mozilla@hocat.ca
push dateThu, 03 Aug 2017 16:21:24 +0000
reviewersglandium
bugs1385539, 1256571
milestone56.0a1
Bug 1385539 - Re-add accidentally deleted documentation of mozbuild.configure.ConfigureSandbox.include_file; r?glandium The code was deleted in Bug 1256571. MozReview-Commit-ID: JgWoxOyMQ8z
python/mozbuild/mozbuild/configure/__init__.py
--- a/python/mozbuild/mozbuild/configure/__init__.py
+++ b/python/mozbuild/mozbuild/configure/__init__.py
@@ -356,16 +356,17 @@ class ConfigureSandbox(dict):
             self._help.add(self._help_option)
         elif moz_logger:
             handler = logging.FileHandler('config.log', mode='w', delay=True)
             handler.setFormatter(formatter)
             logger.addHandler(handler)
 
     def include_file(self, path):
         '''Include one file in the sandbox. Users of this class probably want
+        to use `run` instead.
 
         Note: this will execute all template invocations, as well as @depends
         functions that depend on '--help', but nothing else.
         '''
 
         if self._paths:
             path = mozpath.join(mozpath.dirname(self._paths[-1]), path)
             path = mozpath.normpath(path)