Skip to content

Commit

Permalink
Fixed marklogic-community#374: hooked in placeholder for app_specific…
Browse files Browse the repository at this point in the history
… help, added sample code in app_specific
  • Loading branch information
grtjn committed Feb 24, 2015
1 parent 7bc2b10 commit a449ac0
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
30 changes: 30 additions & 0 deletions deploy/app_specific.rb
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,33 @@ class ServerConfig
# # but it can be called without an environment
# end
end

#
# Uncomment, and adjust below code to get help about your app_specific
# commands included into Roxy help. (ml -h)
#

#class Help
# def self.app_specific
# <<-DOC.strip_heredoc
#
# App-specific commands:
# example Installs app-specific alerting
# DOC
# end
#
# def self.example
# <<-DOC.strip_heredoc
# Usage: ml {env} example [args] [options]
#
# Runs a special example task against given environment.
#
# Arguments:
# this Do this
# that Do that
#
# Options:
# --whatever=value
# DOC
# end
#end
13 changes: 12 additions & 1 deletion deploy/lib/Help.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
class Help
def self.usage
<<-DOC.strip_heredoc
help = <<-DOC.strip_heredoc
Usage:
ml [ENVIRONMENT] COMMAND [ARGS]
Expand Down Expand Up @@ -37,9 +37,20 @@ def self.usage
settings Lists all supported settings for a given environment
test Runs xquery unit tests against the given environment
xqsync Runs XQSync against the given environment
DOC

help += app_specific || ''

help += <<-DOC.strip_heredoc
All commands can be run with -h or --help for more information.
DOC

help
end

def self.app_specific
#stub
end

def self.create
Expand Down

0 comments on commit a449ac0

Please sign in to comment.