Clarify the documentation of the --type-* flags.

Fixes #15
BurntSushi · Sep 24, 2016 · 9ce0484 · 9ce0484
1 parent 346bad7
commit 9ce0484
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 6 deletions.
diff --git a/doc/rg.1 b/doc/rg.1
@@ -254,11 +254,16 @@ Show all supported file types and their associated globs.
 .TP
 .B \-\-type\-add \f[I]ARG\f[] ...
 Add a new glob for a particular file type.
-Example: \-\-type\-add html:\f[I]\&.html,\f[].htm
+Note that this must be passed to every invocation of rg.
 .RS
 .RE
+.PP
+Example: \-\-type\-add html:\f[I]\&.html,\f[].htm
 .TP
 .B \-\-type\-clear \f[I]TYPE\f[] ...
-Clear the file type globs for TYPE.
+Clear the file type globs previously defined for TYPE.
+This only clears the default type definitions that are found inside of
+ripgrep.
+Note that this must be passed to every invocation of rg.
 .RS
 .RE
diff --git a/doc/rg.1.md b/doc/rg.1.md
@@ -164,8 +164,12 @@ the raw speed of grep.
 : Show all supported file types and their associated globs.
 
 --type-add *ARG* ...
-: Add a new glob for a particular file type.
+: Add a new glob for a particular file type. Note that this must be
+  passed to every invocation of rg.
+
   Example: --type-add html:*.html,*.htm
 
 --type-clear *TYPE* ...
-: Clear the file type globs for TYPE.
+: Clear the file type globs previously defined for TYPE. This only clears
+  the default type definitions that are found inside of ripgrep. Note
+  that this must be passed to every invocation of rg.
diff --git a/src/args.rs b/src/args.rs
@@ -163,11 +163,15 @@ File type management options:
         Show all supported file types and their associated globs.
 
     --type-add ARG ...
-        Add a new glob for a particular file type.
+        Add a new glob for a particular file type. Note that this must be
+        passed to every invocation of rg.
+
         Example: --type-add html:*.html,*.htm
 
     --type-clear TYPE ...
-        Clear the file type globs for TYPE.
+        Clear the file type globs previously defined for TYPE. This only clears
+        the default type definitions that are found inside of ripgrep. Note
+        that this must be passed to every invocation of rg.
 ";
 
 /// RawArgs are the args as they are parsed from Docopt. They aren't used