some details on callable(workdir) behaviour

Signed-off-by: Pierre Tardy <pierre.tardy@intel.com>
buildbot · Dec 29, 2014 · 4d0ae82 · 4d0ae82
1 parent 7fe48c3
commit 4d0ae82
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 9 deletions.
diff --git a/master/buildbot/process/build.py b/master/buildbot/process/build.py
@@ -336,11 +336,6 @@ def setupBuild(self, expectations):
             step = factory.buildStep()
             step.setBuild(self)
             step.setBuildSlave(self.slavebuilder.slave)
-            # TODO: remove once we don't have anything depending on setDefaultWorkdir
-            if callable(self.workdir):
-                step.setDefaultWorkdir(self.workdir(self.sources))
-            else:
-                step.setDefaultWorkdir(self.workdir)
             name = step.name
             if name in stepnames:
                 count = stepnames[name]

diff --git a/master/buildbot/process/buildstep.py b/master/buildbot/process/buildstep.py
@@ -340,6 +340,7 @@ def getWorkdir(self):
         if self.workdir is not None:
             return self.workdir
         else:
+            # see :ref:`Factory-Workdir-Functions` for details on how to customize this
             if callable(self.build.workdir):
                 return self.build.workdir(self.build.sources)
             else:

diff --git a/master/docs/developer/cls-buildsteps.rst b/master/docs/developer/cls-buildsteps.rst
@@ -141,9 +141,9 @@ BuildStep
 
         * workdir of the step, if defined
 
-        * workdir of the codebase, if defined
+        * workdir of the BuildFactory (itself defaults to 'build').
 
-        * workdir of the builder (itself defaults to 'build')
+            BuildFactory workdir can be a function of sourcestamp. See :ref:`Factory-Workdir-Functions`
 
     .. py:method:: setDefaultWorkdir(workdir)
 

diff --git a/master/docs/relnotes/index.rst b/master/docs/relnotes/index.rst
@@ -286,8 +286,6 @@ Changes and Removals
 
         * workdir of the step, if defined
 
-        * workdir of the codebase, if defined
-
         * workdir of the builder (itself defaults to 'build')
 
     - setDefaultWorkdir() has been deprecated, but is now behaving the same for all the steps: Setting self.workdir if not already set