Skip to content

Commit 908abc6

Browse files
committed
update manpage list parsing
1 parent 11997a9 commit 908abc6

17 files changed

+504
-243
lines changed

docs/man/man1/oadm-diagnostics.1

+10-4
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,22 @@ you will receive an error if they are not found. For example:
3838
.nf
3939
oadm diagnostics \-\-master\-config=/etc/origin/master/master\-config.yaml
4040

41+
If master/node config files are not found and the \-\-host flag is not
42+
4143
.fi
4244
.RE
43-
.IP \n+[step]
4445

45-
\item If master/node config files are not found and the \-\-host flag is not
46+
.PP
4647
present, host diagnostics are skipped.
47-
\item If the client has cluster\-admin access, this access enables cluster
48+
If the client has cluster\-admin access, this access enables cluster
49+
50+
.PP
4851
diagnostics to run which regular users cannot.
49-
\item If a client config file is not found, client and cluster diagnostics
52+
If a client config file is not found, client and cluster diagnostics
53+
54+
.PP
5055
are skipped.
56+
5157
.PP
5258
Diagnostics may be individually run by passing diagnostic name as arguments.
5359
The available diagnostic names are:

docs/man/man1/oc-adm-diagnostics.1

+10-4
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,22 @@ you will receive an error if they are not found. For example:
3838
.nf
3939
oc adm diagnostics \-\-master\-config=/etc/origin/master/master\-config.yaml
4040

41+
If master/node config files are not found and the \-\-host flag is not
42+
4143
.fi
4244
.RE
43-
.IP \n+[step]
4445

45-
\item If master/node config files are not found and the \-\-host flag is not
46+
.PP
4647
present, host diagnostics are skipped.
47-
\item If the client has cluster\-admin access, this access enables cluster
48+
If the client has cluster\-admin access, this access enables cluster
49+
50+
.PP
4851
diagnostics to run which regular users cannot.
49-
\item If a client config file is not found, client and cluster diagnostics
52+
If a client config file is not found, client and cluster diagnostics
53+
54+
.PP
5055
are skipped.
56+
5157
.PP
5258
Diagnostics may be individually run by passing diagnostic name as arguments.
5359
The available diagnostic names are:

docs/man/man1/oc-create-clusterresourcequota.1

-121
This file was deleted.

docs/man/man1/oc-deploy.1

+17-6
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,26 @@ and scaling up new ones. Use 'oc rollback' to rollback to any previous deploymen
2222

2323
.PP
2424
There are several deployment strategies defined:
25-
.IP \n+[step]
2625

27-
\item Rolling (default) \- scales up the new deployment in stages, gradually reducing the number
26+
.PP
27+
.RS
28+
29+
.nf
30+
Rolling (default) \- scales up the new deployment in stages, gradually reducing the number
31+
32+
.fi
33+
.RE
34+
35+
.PP
2836
of old deployments. If one of the new deployed pods never becomes "ready", the new deployment
29-
will be rolled back (scaled down to zero). Use when your application can tolerate two versions
30-
of code running at the same time (many web applications, scalable databases)
31-
\item Recreate \- scales the old deployment down to zero, then scales the new deployment up to full.
37+
will be rolled back (scaled down to zero). Use when your application can tolerate two versions
38+
of code running at the same time (many web applications, scalable databases)
39+
Recreate \- scales the old deployment down to zero, then scales the new deployment up to full.
40+
41+
.PP
3242
Use when your application cannot tolerate two versions of code running at the same time
33-
\item Custom \- run your own deployment process inside a Docker container using your own scripts.
43+
Custom \- run your own deployment process inside a Docker container using your own scripts.
44+
3445
.PP
3546
If a deployment fails, you may opt to retry it (if the error was transient). Some deployments may
3647
never successfully complete \- in which case you can use the '\-\-latest' flag to force a redeployment.

docs/man/man1/oc-set-volumes.1

+16-5
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,30 @@ you cannot change a pod's volumes once it has been created.
2929

3030
.PP
3131
Volume types include:
32-
.IP \n+[step]
3332

34-
\item emptydir (empty directory) \fIdefault\fP
33+
.PP
34+
.RS
35+
36+
.nf
37+
emptydir (empty directory) *default*
38+
3539
A directory allocated when the pod is created on a local host, is removed when
3640
the pod is deleted and is not copied across servers
37-
\item hostdir (host directory)
41+
hostdir (host directory)
42+
3843
A directory with specific path on any host (requires elevated privileges)
39-
\item persistentvolumeclaim or pvc (persistent volume claim)
44+
persistentvolumeclaim or pvc (persistent volume claim)
45+
4046
Link the volume directory in the container to a persistent volume claim you have
4147
allocated by name \- a persistent volume claim is a request to allocate storage.
4248
Note that if your claim hasn't been bound, your pods will not start.
43-
\item secret (mounted secret)
49+
secret (mounted secret)
50+
4451
Secret volumes mount a named secret to the provided directory.
52+
53+
.fi
54+
.RE
55+
4556
.PP
4657
For descriptions on other volume types, see
4758
\[la]https://docs.openshift.com\[ra]

0 commit comments

Comments
 (0)