Skip to content

Commit ecb2092

Browse files
committed
Use valid ronn syntax in filebucket help
Previously, running `rake manpages` resulted in: roff: ./man/man8/puppet-filebucket.8 warn: unrecognized block tag: "blockquote" This is because '>' is not valid ronn syntax. As a result the "Note" was excluded from the generated `man/man8/puppet-filebucket.8` Also add a new line to separate using a local filebucket.
1 parent ffb5d57 commit ecb2092

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

lib/puppet/application/filebucket.rb

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,11 @@ def help
7676
use your local file bucket by specifying '--local', or by specifying
7777
'--bucket' with a local path.
7878
79-
> **Note**: Enabling and using the backup option, and by extension the
80-
filebucket resource, requires appropriate planning and management to ensure
81-
that sufficient disk space is available for the file backups. Generally, you
82-
can implement this using one of the following two options:
79+
**Note**: Enabling and using the backup option, and by extension the
80+
filebucket resource, requires appropriate planning and management to ensure
81+
that sufficient disk space is available for the file backups. Generally, you
82+
can implement this using one of the following two options:
83+
8384
- Use a `find` command and `crontab` entry to retain only the last X days
8485
of file backups. For example:
8586
@@ -187,6 +188,7 @@ def help
187188
188189
$ puppet filebucket -l -t "2015-05-11 09:30:00" list
189190
d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
191+
190192
## Manage files in a specific local filebucket
191193
$ puppet filebucket -b /tmp/TestBucket backup /tmp/TestFile2
192194
/tmp/TestFile2: d41d8cd98f00b204e9800998ecf8427e

man/man8/puppet-filebucket.8

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ This is a stand\-alone filebucket client for sending files to a local or central
3636
.P
3737
Note that \'filebucket\' defaults to using a network\-based filebucket available on the server named \'puppet\'\. To use this, you\'ll have to be running as a user with valid Puppet certificates\. Alternatively, you can use your local file bucket by specifying \'\-\-local\', or by specifying \'\-\-bucket\' with a local path\.
3838
.
39+
.P
40+
\fBNote\fR: Enabling and using the backup option, and by extension the filebucket resource, requires appropriate planning and management to ensure that sufficient disk space is available for the file backups\. Generally, you can implement this using one of the following two options:
41+
.
42+
.IP "\(bu" 4
43+
Use a \fBfind\fR command and \fBcrontab\fR entry to retain only the last X days of file backups\. For example:
44+
.
45+
.IP "" 0
46+
.
3947
.IP "" 4
4048
.
4149
.nf
@@ -146,6 +154,7 @@ $ puppet filebucket \-l \-f "2015\-05\-11 09:30:00" list
146154

147155
$ puppet filebucket \-l \-t "2015\-05\-11 09:30:00" list
148156
d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
157+
149158
## Manage files in a specific local filebucket
150159
$ puppet filebucket \-b /tmp/TestBucket backup /tmp/TestFile2
151160
/tmp/TestFile2: d41d8cd98f00b204e9800998ecf8427e

0 commit comments

Comments
 (0)