openstack/swift
Code Issues Proposed changes

Man page lintian errors and warnings

Browse Source 
Used groff to recreate the errors. I believe all the issues
except `binary-without-manpage` are solved. Would like
confirmation from someone using Lintian.

Closes-Bug: #1210114
Change-Id: I533205c53efdb7cdf3645cc3e3dc487f9ee5640a
This commit is contained in:
Tobias Stevenson 2013-08-27 16:03:58 -05:00
parent 3dfc094662
commit 83a6ec1683
5 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/manpages/container-server.conf.5
View File

@ -119,11 +119,11 @@ This is normally \fBegg:swift#container\fR.
Label used when logging. The default is container-server.
.IP "\fBset log_facility\fR
Syslog log facility. The default is LOG_LOCAL0.
.IP "\fB set log_level\fR
.IP "\fBset log_level\fR
Logging level. The default is INFO.
.IP "\fB set log_requests\fR
.IP "\fBset log_requests\fR
Enables request logging. The default is True.
.IP "\fB set log_address\fR
.IP "\fBset log_address\fR
Logging address. The default is /dev/log.
.IP \fBnode_timeout\fR
Request timeout to external services. The default is 3 seconds.
@ -224,7 +224,7 @@ Number of reaper workers to spawn. The default is 4.
Request timeout to external services. The default is 3 seconds.
.IP \fBconn_timeout\fR
Connection timeout to external services. The default is 0.5 seconds.
.IP \fBslowdown = 0.01\fR
.IP \fBslowdown\fR
Slowdown will sleep that amount between containers. The default is 0.01 seconds.
.IP \fBaccount_suppression_time\fR
Seconds to suppress updating an account that has generated an error. The default is 60 seconds.
@ -286,4 +286,4 @@ and
.SH "SEE ALSO"
.BR swift-container-server(1),
.BR swift-container-server(1)

2
doc/manpages/object-server.conf.5
View File

@ -236,7 +236,7 @@ Number of reaper workers to spawn. The default is 1.
Request timeout to external services. The default is 10 seconds.
.IP \fBconn_timeout\fR
Connection timeout to external services. The default is 0.5 seconds.
.IP \fBslowdown = 0.01\fR
.IP \fBslowdown\fR
Slowdown will sleep that amount between objects. The default is 0.01 seconds.
.RE
.PD

10
doc/manpages/proxy-server.conf.5
View File

@ -475,7 +475,7 @@ Default is localhost.
Default is 8125.
.IP \fBaccess_log_statsd_default_sample_rate\fR
Default is 1.
.IP \fBaccess_log_statsd_metric_prefix =
.IP \fBaccess_log_statsd_metric_prefix\fR
Default is "" (empty-string)
.IP \fBaccess_log_headers\fR
Default is False.
@ -499,13 +499,13 @@ that are acceptable within this section.
.IP \fBuse\fR
Entry point for paste.deploy for the proxy server. This is the reference to the installed python egg.
This is normally \fBegg:swift#proxy\fR.
.IP \fBset log_name\fR
.IP "\fBset log_name\fR"
Label used when logging. The default is proxy-server.
.IP \fBset log_facility\fR
.IP "\fBset log_facility\fR"
Syslog log facility. The default is LOG_LOCAL0.
.IP \fB set log_level\fR
.IP "\fBset log_level\fR"
Logging level. The default is INFO.
.IP \fB set log_address\fR
.IP "\fBset log_address\fR"
Logging address. The default is /dev/log.
.IP \fBlog_handoffs\fR
Log when handoff locations are used. Default is True.

18
doc/manpages/swift-orphans.1
View File

@ -14,31 +14,31 @@
.\" implied.
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.\"
.TH swift-orphans 1 "3/15/2012" "Linux" "OpenStack Swift"
.SH NAME
.SH NAME
.LP
.B swift-orphans
\- Openstack-swift orphans tool
.SH SYNOPSIS
.LP
.B swift-orphans
.B swift-orphans
[-h|--help] [-a|--age] [-k|--kill] [-w|--wide] [-r|--run-dir]
.SH DESCRIPTION
.SH DESCRIPTION
.PP
Lists and optionally kills orphaned Swift processes. This is done by scanning
/var/run/swift or the directory specified to the -r switch for .pid files and
/var/run/swift or the directory specified to the \-r switch for .pid files and
listing any processes that look like Swift processes but aren't associated with
the pids in those .pid files. Any Swift processes running with the 'once'
parameter are ignored, as those are usually for full-speed audit scans and
such.
Example (sends SIGTERM to all orphaned Swift processes older than two hours):
swift-orphans -a 2 -k TERM
Example (sends SIGTERM to all orphaned Swift processes older than two hours):
swift-orphans \-a 2 \-k TERM
The options are as follows:
@ -62,9 +62,9 @@ The options are as follows:
.PD
.RE
.SH DOCUMENTATION
.LP
More documentation about Openstack-Swift can be found at
More documentation about Openstack-Swift can be found at
.BI http://swift.openstack.org/index.html

32
doc/manpages/swift-recon.1
View File

@ -14,26 +14,26 @@
.\" implied.
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.\"
.TH swift-recon 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME
.SH NAME
.LP
.B swift-recon
\- Openstack-swift recon middleware cli tool
.SH SYNOPSIS
.LP
.B swift-recon
.B swift-recon
\ <server_type> [-v] [--suppress] [-a] [-r] [-u] [-d] [-l] [--md5] [--auditor] [--updater] [--expirer] [--sockstat]
.SH DESCRIPTION
.SH DESCRIPTION
.PP
The swift-recon cli tool can be used to retrieve various metrics and telemetry information about
a cluster that has been collected by the swift-recon middleware.
a cluster that has been collected by the swift-recon middleware.
In order to make use of the swift-recon middleware, update the object-server.conf file and
enable the recon middleware by adding a pipeline entry and setting its option(s). You can view
In order to make use of the swift-recon middleware, update the object-server.conf file and
enable the recon middleware by adding a pipeline entry and setting its option(s). You can view
more information in the example section below.
@ -69,13 +69,13 @@ Get cluster quarantine stats
.IP "\fB--md5\fR"
Get md5sum of servers ring and compare to local cop
.IP "\fB--all\fR"
Perform all checks. Equivalent to -arudlq --md5
Perform all checks. Equivalent to \-arudlq \-\-md5
.IP "\fB-z ZONE, --zone=ZONE\fR"
Only query servers in specified zone
.IP "\fB--swiftdir=PATH\fR"
Default = /etc/swift
.PD
.RE
.RE
@ -84,16 +84,16 @@ Default = /etc/swift
.PD 0
.RS 0
.IP "ubuntu:~$ swift-recon -q --zone 3"
.IP "==============================================================================="
.IP "================================================================="
.IP "[2011-10-18 19:36:00] Checking quarantine dirs on 1 hosts... "
.IP "[Quarantined objects] low: 4, high: 4, avg: 4, total: 4 "
.IP "[Quarantined accounts] low: 0, high: 0, avg: 0, total: 0 "
.IP "[Quarantined containers] low: 0, high: 0, avg: 0, total: 0 "
.IP "==============================================================================="
.IP "================================================================="
.RE
.RS 0
Finally if you also wish to track asynchronous pending’s you will need to setup a
Finally if you also wish to track asynchronous pending’s you will need to setup a
cronjob to run the swift-recon-cron script periodically:
.IP "*/5 * * * * swift /usr/bin/swift-recon-cron /etc/swift/object-server.conf"
@ -104,9 +104,9 @@ cronjob to run the swift-recon-cron script periodically:
.SH DOCUMENTATION
.LP
More documentation about Openstack-Swift can be found at
.BI http://swift.openstack.org/index.html
Also more specific documentation about swift-recon can be found at
More documentation about Openstack-Swift can be found at
.BI http://swift.openstack.org/index.html
Also more specific documentation about swift-recon can be found at
.BI http://swift.openstack.org/admin_guide.html#cluster-telemetry-and-monitoring