Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dadgar committed Jun 7, 2016
1 parent cc80c24 commit baff94f
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 3 deletions.
2 changes: 1 addition & 1 deletion command/meta.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ func generalOptionsUsage() string {
Default = http://127.0.0.1:4646
-region=<region>
The region of the Nomad servers to forward commands too.
The region of the Nomad servers to forward commands to.
Overrides the NOMAD_REGION environment variable if set.
Defaults to the Agent's local region.
`
Expand Down
2 changes: 1 addition & 1 deletion command/plan.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Usage: nomad plan [options] <file>
give insight into what the scheduler will attempt to do and why.
If the job has specified the region, the -region flag and NOMAD_REGION
environment variable are overridden to the job's region.
environment variable are overridden and the the job's region is used.
General Options:
Expand Down
2 changes: 1 addition & 1 deletion command/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Usage: nomad run [options] <file>
issues or internal errors, are indicated by exit code 1.
If the job has specified the region, the -region flag and NOMAD_REGION
environment variable are overridden to the job's region.
environment variable are overridden and the the job's region is used.
General Options:
Expand Down
4 changes: 4 additions & 0 deletions website/helpers/command_helpers.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ def general_options_usage()
<<EOF
* `-address=<addr>`: The address of the Nomad server. Overrides the `NOMAD_ADDR`
environment variable if set. Defaults to `http://127.0.0.1:4646`.
* `-region=<region>`: The region of the Nomad server to forward commands to.
Overrides the `NOMAD_REGION` environment variable if set. Defaults to the
Agent's local region.
EOF
end
end
3 changes: 3 additions & 0 deletions website/source/docs/commands/run.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ there are job placement issues encountered (unsatisfiable constraints, resource
exhaustion, etc), then the exit code will be 2. Any other errors, including
client connection issues or internal errors, are indicated by exit code 1.

If the job has specified the region, the -region flag and NOMAD_REGION
environment variable are overridden and the the job's region is used.

## General Options

<%= general_options_usage %>
Expand Down

0 comments on commit baff94f

Please sign in to comment.