Remove most "-o filenames" options to "complete".

Turn it on dynamically when needed instead; see doc/styleguide.txt for
a longer explanation.  This fixes many non-filename completions which
had been previously more or less broken due to unwanted
escape-as-filenames behavior.

1 files changed, 12 insertions, 0 deletions

diff --git a/doc/styleguide.txt b/doc/styleguide.txt
index 4dbd5732..24f28636 100644
--- a/doc/styleguide.txt
+++ b/doc/styleguide.txt
@@ -54,6 +54,18 @@ is preferable because anyone, with any keyboard layout, is able to
 type it. Backticks aren't always available, without doing strange
 key combinations.
 
+-o filenames
+------------
+
+As a rule of thumb, do not use "complete -o filenames". Doing it makes
+it take effect for all completions from the affected function, which
+may break things if some completions from the function must not be
+escaped as filenames. Instead, use the _compopt_o_filenames function
+to turn on "-o filenames" behavior dynamically when returning
+completions that need that kind of processing (e.g. file and command
+names). The _filedir and _filedir_xspec helpers do this automatically
+whenever they return some completions.
+
 /////////////////////////////////////////
 case/esac vs if
 ---------------