Skip to content

Commit

Permalink
maint: Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stschulte committed Mar 29, 2015
1 parent cbedc0f commit c169654
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions lib/puppet/type/rpmkey.rb
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
Puppet::Type.newtype(:rpmkey) do

@doc = "Define public GPG keys that should be part of the rpm
keyring."
keyring.
**Autorequires:** If puppet is managing the keyfile as a `file` resource,
the `rpmkey` resource will autorequire that file"

newparam(:name) do
desc "The name of the key. This is the keyID (in hex) in
uppercase."
desc "The `name` of the `rpmkey` resource has to be the keyID (in hex)
of the gpg key in uppercase. If you have the public key available as a
file but you are unsure of the correct keyID, use `gpg` to extract the
keyID. For example, to find the keyID used by EPEL 7:
$ gpg ./RPM-GPG-KEY-EPEL-7
pub 4096R/352C64E5 2013-12-16 Fedora EPEL (7) <[email protected]>
in this case, `352C64E5` would be the correct name."

isnamevar

Expand Down

0 comments on commit c169654

Please sign in to comment.