summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Pittman <daniel@puppetlabs.com>2011-05-02 12:44:13 -0700
committerDaniel Pittman <daniel@puppetlabs.com>2011-05-02 15:26:09 -0700
commitb20e9779f1c60a2a2ea1ddf21b3c5e06d8f68ac4 (patch)
treedfdfe515aa34034fb285fa675a04a7e3518f91fe
parent3bb8bd30c039edaab0f9eb4ff6865ba5077bf549 (diff)
downloadpuppet-b20e9779f1c60a2a2ea1ddf21b3c5e06d8f68ac4.tar.gz
puppet-b20e9779f1c60a2a2ea1ddf21b3c5e06d8f68ac4.tar.xz
puppet-b20e9779f1c60a2a2ea1ddf21b3c5e06d8f68ac4.zip
(#7304) Improve help from `puppet foo`
This addresses two of the four points: we now quote the subcommand name, and emit 'Usage: ' before the usage information on the puppet command line. Reviewed-By: Nick Lewis <nick@puppetlabs.com>
-rw-r--r--lib/puppet/face/help/global.erb2
-rw-r--r--lib/puppet/util/command_line.rb2
-rwxr-xr-xspec/unit/util/command_line_spec.rb10
3 files changed, 6 insertions, 8 deletions
diff --git a/lib/puppet/face/help/global.erb b/lib/puppet/face/help/global.erb
index f4c761b2b..a19ce1fb0 100644
--- a/lib/puppet/face/help/global.erb
+++ b/lib/puppet/face/help/global.erb
@@ -1,4 +1,4 @@
-puppet <subcommand> [options] <action> [options]
+Usage: puppet <subcommand> [options] <action> [options]
Available subcommands, from Puppet Faces:
% Puppet::Face.faces.sort.each do |name|
diff --git a/lib/puppet/util/command_line.rb b/lib/puppet/util/command_line.rb
index 714d03f74..daf49e8de 100644
--- a/lib/puppet/util/command_line.rb
+++ b/lib/puppet/util/command_line.rb
@@ -65,7 +65,7 @@ module Puppet
# return to the caller. How strange we are. --daniel 2011-04-11
else
unless subcommand_name.nil? then
- puts "Error: Unknown Puppet subcommand #{subcommand_name}.\n"
+ puts "Error: Unknown Puppet subcommand '#{subcommand_name}'"
end
# Doing this at the top of the file is natural, but causes puppet.rb
diff --git a/spec/unit/util/command_line_spec.rb b/spec/unit/util/command_line_spec.rb
index 81612ee5c..d60bbb198 100755
--- a/spec/unit/util/command_line_spec.rb
+++ b/spec/unit/util/command_line_spec.rb
@@ -1,7 +1,7 @@
#!/usr/bin/env rspec
require 'spec_helper'
-
+require 'puppet/face'
require 'puppet/util/command_line'
describe Puppet::Util::CommandLine do
@@ -98,11 +98,9 @@ describe Puppet::Util::CommandLine do
Puppet::Util.expects(:which).with('puppet-whatever').returns(nil)
commandline.expects(:system).never
- text = Puppet::Face[:help, :current].help
- commandline.expects(:puts).with { |x| x =~ /Unknown Puppet subcommand/ }
- commandline.expects(:puts).with text
-
- commandline.execute
+ expect {
+ commandline.execute
+ }.to have_printed(/Unknown Puppet subcommand 'whatever'/)
end
end
end