Permalink
Browse files

Add notes about adding options

  • Loading branch information...
1 parent 7b3d6f5 commit 1d918d9c0d4e9eb5ddcfefaf8964d1b829d1fdb4 @hoelzro hoelzro committed Oct 16, 2012
Showing with 15 additions and 0 deletions.
  1. +15 −0 ConfigLoader.pm
View
@@ -147,6 +147,21 @@ sub get_arg_spec {
This is because we now have -k/--known-types which makes it only select files
of known types, rather than any text file (which is the behavior of ack 1.x).
EOT
+
+=for Adding-Options
+
+ *** IF YOU ARE MODIFYING ACK PLEASE READ THIS ***
+
+ If you plan to add a new option to ack, please make sure of
+ the following:
+
+ * Your new option has a test underneath the t/ directory.
+ * Your new option is explained when a user invokes ack --help.
+ (See App::Ack::show_help)
+ * Your new option is explained when a user invokes ack --man.
+ (See the POD at the end of ./ack)
+ * Add your option to t/config-loader.t
+=cut
return {
1 => sub { $opt->{1} = $opt->{m} = 1 },
'A|after-context=i' => \$opt->{after_context},

0 comments on commit 1d918d9

Please sign in to comment.