Skip to content

Commit

Permalink
update generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
juanvallejo committed Dec 1, 2016
1 parent 3854b12 commit cb27bff
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 32 deletions.
4 changes: 2 additions & 2 deletions docs/man/man1/oc-new-app.1
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,8 @@ If you provide source code, a new build will be automatically triggered. You can
Search all templates, image streams, and Docker images that match the arguments provided.

.PP
\fB\-\-strategy\fP=
Specify the build strategy to use if you don't want to detect (docker|pipeline|source).
\fB\-\-strategy\fP=""
Specify the build strategy to use if you don't want to detect (docker|source).

.PP
\fB\-\-template\fP=[]
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oc-new-build.1
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ Once the build configuration is created a new build will be automatically trigge
Specify the file or directory to copy from the source image and its destination in the build directory. Format: [source]:[destination\-dir].

.PP
\fB\-\-strategy\fP=
Specify the build strategy to use if you don't want to detect (docker|pipeline|source).
\fB\-\-strategy\fP=""
Specify the build strategy to use if you don't want to detect (docker|source).

.PP
\fB\-\-to\fP=""
Expand Down
8 changes: 4 additions & 4 deletions docs/man/man1/oc-process.1
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,6 @@ The output of the process command is always a list of one or more resources. You
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).

.PP
\fB\-p\fP, \fB\-\-param\fP=[]
Specify a key\-value pair (eg. \-p FOO=BAR) to set/override a parameter value in the template.

.PP
\fB\-\-parameters\fP=false
Do not process but only print available parameters
Expand All @@ -56,6 +52,10 @@ The output of the process command is always a list of one or more resources. You
Template string or path to template file to use when \-o=template or \-o=templatefile. The template format is golang templates [
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]

.PP
\fB\-v\fP, \fB\-\-value\fP=[]
Specify a key\-value pair (eg. \-v FOO=BAR) to set/override a parameter value in the template.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
Expand Down
9 changes: 1 addition & 8 deletions docs/man/man1/oc-start-build.1
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@ Start a build
This command starts a new build for the provided build config or copies an existing build using \-\-from\-build= <name>. Pass the \-\-follow flag to see output from the build.

.PP
In addition, you can pass a file, directory, or source code repository with the \-\-from\-file, \-\-from\-dir, or \-\-from\-repo flags directly to the build. The contents will be streamed to the build and override the current build source settings. When using \-\-from\-repo, the \-\-commit flag can be used to control which branch, tag, or commit is sent to the server. If you pass \-\-from\-file, the file is placed in the root of an empty directory with the same filename. It is also possible to pass a http or https url to \-\-from\-file and \-\-from\-archive, however authentication is not supported and in case of https the certificate must be valid and recognized by your system.

.PP
Note that builds triggered from binary input will not preserve the source on the server, so rebuilds triggered by base image changes will use the source specified on the build config.
In addition, you can pass a file, directory, or source code repository with the \-\-from\-file, \-\-from\-dir, or \-\-from\-repo flags directly to the build. The contents will be streamed to the build and override the current build source settings. When using \-\-from\-repo, the \-\-commit flag can be used to control which branch, tag, or commit is sent to the server. If you pass \-\-from\-file, the file is placed in the root of an empty directory with the same filename. Note that builds triggered from binary input will not preserve the source on the server, so rebuilds triggered by base image changes will use the source specified on the build config.


.SH OPTIONS
Expand All @@ -42,10 +39,6 @@ Note that builds triggered from binary input will not preserve the source on the
\fB\-F\fP, \fB\-\-follow\fP=false
Start a build and watch its logs until it completes or fails

.PP
\fB\-\-from\-archive\fP=""
An archive (tar, tar.gz, zip) to be extracted before the build and used as the binary input.

.PP
\fB\-\-from\-build\fP=""
Specify the name of a build which should be re\-run
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/openshift-cli-new-app.1
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,8 @@ If you provide source code, a new build will be automatically triggered. You can
Search all templates, image streams, and Docker images that match the arguments provided.

.PP
\fB\-\-strategy\fP=
Specify the build strategy to use if you don't want to detect (docker|pipeline|source).
\fB\-\-strategy\fP=""
Specify the build strategy to use if you don't want to detect (docker|source).

.PP
\fB\-\-template\fP=[]
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/openshift-cli-new-build.1
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ Once the build configuration is created a new build will be automatically trigge
Specify the file or directory to copy from the source image and its destination in the build directory. Format: [source]:[destination\-dir].

.PP
\fB\-\-strategy\fP=
Specify the build strategy to use if you don't want to detect (docker|pipeline|source).
\fB\-\-strategy\fP=""
Specify the build strategy to use if you don't want to detect (docker|source).

.PP
\fB\-\-to\fP=""
Expand Down
8 changes: 4 additions & 4 deletions docs/man/man1/openshift-cli-process.1
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,6 @@ The output of the process command is always a list of one or more resources. You
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).

.PP
\fB\-p\fP, \fB\-\-param\fP=[]
Specify a key\-value pair (eg. \-p FOO=BAR) to set/override a parameter value in the template.

.PP
\fB\-\-parameters\fP=false
Do not process but only print available parameters
Expand All @@ -56,6 +52,10 @@ The output of the process command is always a list of one or more resources. You
Template string or path to template file to use when \-o=template or \-o=templatefile. The template format is golang templates [
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]

.PP
\fB\-v\fP, \fB\-\-value\fP=[]
Specify a key\-value pair (eg. \-v FOO=BAR) to set/override a parameter value in the template.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
Expand Down
9 changes: 1 addition & 8 deletions docs/man/man1/openshift-cli-start-build.1
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@ Start a build
This command starts a new build for the provided build config or copies an existing build using \-\-from\-build= <name>. Pass the \-\-follow flag to see output from the build.

.PP
In addition, you can pass a file, directory, or source code repository with the \-\-from\-file, \-\-from\-dir, or \-\-from\-repo flags directly to the build. The contents will be streamed to the build and override the current build source settings. When using \-\-from\-repo, the \-\-commit flag can be used to control which branch, tag, or commit is sent to the server. If you pass \-\-from\-file, the file is placed in the root of an empty directory with the same filename. It is also possible to pass a http or https url to \-\-from\-file and \-\-from\-archive, however authentication is not supported and in case of https the certificate must be valid and recognized by your system.

.PP
Note that builds triggered from binary input will not preserve the source on the server, so rebuilds triggered by base image changes will use the source specified on the build config.
In addition, you can pass a file, directory, or source code repository with the \-\-from\-file, \-\-from\-dir, or \-\-from\-repo flags directly to the build. The contents will be streamed to the build and override the current build source settings. When using \-\-from\-repo, the \-\-commit flag can be used to control which branch, tag, or commit is sent to the server. If you pass \-\-from\-file, the file is placed in the root of an empty directory with the same filename. Note that builds triggered from binary input will not preserve the source on the server, so rebuilds triggered by base image changes will use the source specified on the build config.


.SH OPTIONS
Expand All @@ -42,10 +39,6 @@ Note that builds triggered from binary input will not preserve the source on the
\fB\-F\fP, \fB\-\-follow\fP=false
Start a build and watch its logs until it completes or fails

.PP
\fB\-\-from\-archive\fP=""
An archive (tar, tar.gz, zip) to be extracted before the build and used as the binary input.

.PP
\fB\-\-from\-build\fP=""
Specify the name of a build which should be re\-run
Expand Down

0 comments on commit cb27bff

Please sign in to comment.