Merge pull request ctrlpvim#599 from ydzhou/master

Update doc related to wildignore
BioBox · Mar 22, 2022 · 8150fdd · 8150fdd
2 parents 3f1ba86 + 2580134
commit 8150fdd
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 36 deletions.
diff --git a/doc/ctrlp.cnx b/doc/ctrlp.cnx
@@ -241,22 +241,8 @@ OPTIONS                                                         *ctrlp-options*
 <
 注意: 当命令使用 |g:ctrlp_user_command| 定义时该选项无效。
 
-                                                           *'ctrlp-wildignore'*
-你可以使用Vim的 |'wildignore'| 来从结果集中排序文件或目录。
-例子: >
-  " 排除版本控制文件
-  set wildignore+=*/.git/*,*/.hg/*,*/.svn/*        " Linux/MacOSX
-  set wildignore+=*\\.git\\*,*\\.hg\\*,*\\.svn\\*  " Windows ('noshellslash')
-<
-注意 #1: 每个目录设置前的字符 `*/` 是必须的。
-
-注意 #2: |wildignore| 影响 |expand()| ， |globpath()| 和 |glob()| 的结果，这些函数被很
-多插件用来在系统中执行查找。（例如和版本控制系统有关的插件在查找.git/、.hg/等，
-一些其他插件用来在Windows上查找外部的*.exe工具），所以要修改 |wildignore| 时请先
-考虑清楚。
-
                                                       *'g:ctrlp_custom_ignore'*
-作为对 |'wildignore'| 和 |g:ctrlp_show_hidden| 的补充，用来设置你只是想在CtrlP中隐藏的文件和目录。使用正
+除了 |g:ctrlp_show_hidden|，你可以用这个选项设置你想在CtrlP中隐藏的文件和目录。使用正
 则表达式来指定匹配模式: >
   let g:ctrlp_custom_ignore = ''
 <
@@ -274,9 +260,7 @@ OPTIONS                                                         *ctrlp-options*
     \ 'func': 'some#custom#match_function'
     \ }
 <
-注意 #1: 默认情况下， |wildignore| 和 |g:ctrlp_custom_ignore| 只在 |globpath()| 被用
-来扫描文件的情况下使用，这样这些选项在那些使用 |g:ctrlp_user_command| 定义的命
-令中不会生效。
+注意 #1: |g:ctrlp_custom_ignore| 在已经使用 |g:ctrlp_user_command| 的时候不会生效。
 
 注意 #2: 当改变选项的变量类型时，记得先 |:unlet| ，或者重启Vim来避免这个错误：
 "E706: Variable type mismatch" 。
@@ -285,6 +269,9 @@ OPTIONS                                                         *ctrlp-options*
 自动加载的函数。函数必须接受两个参数，要匹配的条目和接受的类型，类型可以是目
 录、文件和链接。如果条目被忽略，函数需要返回1，反之，返回0。
 
+注意 #4: 如果设置 |g:ctrlp_use_readdir| 为0，你可以使用 Vim 的 |'wildignore'|
+来将文件和目录排除出搜索结果。
+
                                                           *'g:ctrlp_max_files'*
 扫描文件的最大数量，设置为0时不进行限制: >
   let g:ctrlp_max_files = 10000

diff --git a/doc/ctrlp.txt b/doc/ctrlp.txt
@@ -240,23 +240,8 @@ Set this to 1 if you want CtrlP to scan for dotfiles and dotdirs: >
 Note: does not apply when a command defined with |g:ctrlp_user_command| is
 being used.
 
-                                                           *'ctrlp-wildignore'*
-You can use Vim's |'wildignore'| to exclude files and directories from the
-results.
-Examples: >
-  " Excluding version control directories
-  set wildignore+=*/.git/*,*/.hg/*,*/.svn/*        " Linux/MacOSX
-  set wildignore+=*\\.git\\*,*\\.hg\\*,*\\.svn\\*  " Windows ('noshellslash')
-<
-Note #1: the `*/` in front of each directory glob is required.
-
-Note #2: |wildignore| influences the result of |expand()|, |globpath()| and
-|glob()| which many plugins use to find stuff on the system (e.g. VCS related
-plugins look for .git/, .hg/,... some other plugins look for external *.exe
-tools on Windows). So be a little mindful of what you put in your |wildignore|.
-
                                                       *'g:ctrlp_custom_ignore'*
-In addition to |'wildignore'| and |g:ctrlp_show_hidden|, use this for files
+In addition to |g:ctrlp_show_hidden|, use this for files
 and directories you want only CtrlP to not show. Use regexp to specify the
 patterns: >
   let g:ctrlp_custom_ignore = ''
@@ -275,8 +260,7 @@ Examples: >
     \ 'func': 'some#custom#match_function'
     \ }
 <
-Note #1: by default, |wildignore| and |g:ctrlp_custom_ignore| only apply when
-|globpath()| is used to scan for files, thus these options do not apply when a
+Note #1: |g:ctrlp_custom_ignore| does not apply when a
 command defined with |g:ctrlp_user_command| is being used.
 
 Note #2: when changing the option's variable type, remember to |:unlet| it
@@ -288,6 +272,9 @@ recommended here. The function must take 2 parameters, the item to match and
 its type. The type will be "dir", "file", or "link". The function must return
 1 if the item should be ignored, 0 otherwise.
 
+Note #4: when |g:ctrlp_use_readdir| is set to 0, you can also use Vim's |'wildignore'| 
+to exclude files and directories.
+
                                                           *'g:ctrlp_max_files'*
 The maximum number of files to scan, set to 0 for no limit: >
   let g:ctrlp_max_files = 10000