Skip to content

Commit

Permalink
switch terminology in user-facing documentation (#148)
Browse files Browse the repository at this point in the history
  • Loading branch information
steven-terrana authored Mar 2, 2021
1 parent 616eae1 commit 9b1f304
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
import java.util.Map;

/**
* Runs a Bourne shell script asynchronously on a slave.
* Runs a Bourne shell script asynchronously on a build agent.
*/
public final class ShellStep extends DurableTaskStep {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
* Used like:
* <pre>
* node("foo") {
* // execute some stuff in a slave that has a label "foo" while workflow has this slave
* // execute some stuff in a build agent that has a label "foo" while workflow has this build agent
* }
* </pre>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -773,7 +773,7 @@ private static final class Callback extends BodyExecutionCallback.TailCall {
}

/**
* Occupies {@link Executor} while workflow uses this slave.
* Occupies {@link Executor} while workflow uses this build agent.
*/
@ExportedBean
private final class PlaceholderExecutable implements ContinuableExecutable, AccessControlled {
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/index.jelly
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ THE SOFTWARE.

<?jelly escape-by-default='true'?>
<div>
Pipeline steps locking agents and workspaces, and running external processes that may survive a Jenkins restart or slave reconnection.
Pipeline steps locking agents and workspaces, and running external processes that may survive a Jenkins restart or agent reconnection.
</div>
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<div>
Allocates an executor on a node (typically a slave) and runs further code in the context of a workspace on that slave.
Allocates an executor on a node (typically a build agent) and runs further code in the context of a workspace on that agent.
</div>
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
A workspace is automatically allocated for you with the <code>node</code> step,
or you can get an alternate workspace with this <code>ws</code> step,
but by default the location is chosen automatically.
(Something like <code>SLAVE_ROOT/workspace/JOB_NAME@2</code>.)
(Something like <code>AGENT_ROOT/workspace/JOB_NAME@2</code>.)
</p>
<p>
You can instead specify a path here and that workspace will be locked instead.
(The path may be relative to the slave root, or absolute.)
(The path may be relative to the build agent root, or absolute.)
</p>
<p>
If concurrent builds ask for the same workspace, a directory with a suffix such as <code>@2</code> may be locked instead.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ public class ExecutorStepTest {
@Rule public LoggerRule logging = new LoggerRule();

/**
* Executes a shell script build on a slave.
* Executes a shell script build on a build agent.
*
* This ensures that the context variable overrides are working as expected, and
* that they are persisted and resurrected.
Expand Down Expand Up @@ -184,7 +184,7 @@ public class ExecutorStepTest {
}

/**
* Executes a shell script build on a slave and ensures the processes are
* Executes a shell script build on a build agent and ensures the processes are
* killed at the end of the run
*
* This ensures that the context variable overrides are working as expected, and
Expand Down

0 comments on commit 9b1f304

Please sign in to comment.