summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrice Figureau <brice-puppet@daysofwonder.com>2009-12-28 16:52:34 +0100
committerJames Turnbull <james@lovedthanlost.net>2010-01-18 23:19:28 +1100
commit2044550137bf923f9620b25eb0e8c92eefd6db6f (patch)
tree26c5cb956a63a9ce15daafe9123e8af6bea775d8
parentd31ff7ebee14f79b523c3fe4c974d4e6add47a2d (diff)
downloadpuppet-2044550137bf923f9620b25eb0e8c92eefd6db6f.tar.gz
puppet-2044550137bf923f9620b25eb0e8c92eefd6db6f.tar.xz
puppet-2044550137bf923f9620b25eb0e8c92eefd6db6f.zip
Fix #2894 - exclude .pp files under modules files directories
Selinux modules files also ends in ".pp". Puppetdoc tries to parse them as if they are regular puppet files and then fails. This patch makes sure puppetdoc tells RDoc to exclude parsing .pp files in the modules files section. Signed-off-by: Brice Figureau <brice-puppet@daysofwonder.com>
-rw-r--r--lib/puppet/util/rdoc.rb1
-rwxr-xr-xspec/unit/util/rdoc.rb6
2 files changed, 7 insertions, 0 deletions
diff --git a/lib/puppet/util/rdoc.rb b/lib/puppet/util/rdoc.rb
index 4edbf06a6..fc4e2c6cd 100644
--- a/lib/puppet/util/rdoc.rb
+++ b/lib/puppet/util/rdoc.rb
@@ -23,6 +23,7 @@ module Puppet::Util::RDoc
options = [ "--fmt", "puppet",
"--quiet",
"--force-update",
+ "--exclude", "/modules/[^/]*/files/.*\.pp$",
"--op", outputdir ]
options += files
diff --git a/spec/unit/util/rdoc.rb b/spec/unit/util/rdoc.rb
index eeaaa3202..25c94a1c7 100755
--- a/spec/unit/util/rdoc.rb
+++ b/spec/unit/util/rdoc.rb
@@ -49,6 +49,12 @@ describe Puppet::Util::RDoc do
Puppet::Util::RDoc.rdoc("myoutputdir", [])
end
+ it "should tell RDoc to exclude .pp files under any modules/<mod>/files section" do
+ @rdoc.expects(:document).with { |args| args.include?("--exclude") and args.include?("/modules/[^/]*/files/.*\.pp$") }
+
+ Puppet::Util::RDoc.rdoc("myoutputdir", [])
+ end
+
it "should give all the source directories to RDoc" do
@rdoc.expects(:document).with { |args| args.include?("sourcedir") }