pathogen.vim 2.3

* Deprecation warnings.
* Introduce pathogen#interpose() to replace incubate().
* Fix glob issues with fish shell.
* Silence all errors in :helptags.

CONTRIBUTING.markdown

@@ -0,0 +1,14 @@
+If your [commit message sucks](http://stopwritingramblingcommitmessages.com/),
+I'm not going to accept your pull request.  I've explained very politely
+dozens of times that
+[my general guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+are absolute rules on my own repositories, so I may lack the energy to
+explain it to you yet another time.  And please, if I ask you to change
+something, `git commit --amend`.
+
+Beyond that, don't be shy about asking before patching.  What takes you
+hours might take me minutes simply because I have both domain knowledge
+and a perverse knowledge of Vim script so vast that many would consider
+it a symptom of mental illness.  On the flip side, some ideas I'll
+reject no matter how good the implementation is.  "Send a patch" is an
+edge case answer in my book.

README.markdown

@@ -49,7 +49,7 @@ trailing `{}` is supported.
 
 You can also pass an absolute path instead.  I keep the plugins I maintain under `~/src`, and this is how I add them:
 
-    execute pathogen#infect('~/src/vim/bundle/{}')
+    execute pathogen#infect('bundle/{}', '~/src/vim/bundle/{}')
 
 Normally to generate documentation, Vim expects you to run `:helptags`
 on each directory with documentation (e.g., `:helptags ~/.vim/doc`).
@@ -66,7 +66,7 @@ It's well documented.
 ## Runtime File Editing
 
 `:Vopen`, `:Vedit`, `:Vsplit`, `:Vvsplit`, `:Vtabedit`, `:Vpedit`, and
-`:Vread` have all moved to [scriptease.vim][]
+`:Vread` have all moved to [scriptease.vim][].
 
 [scriptease.vim]: https://github.com/tpope/vim-scriptease
 
@@ -103,6 +103,14 @@ If you really must use one:
     :!mkdir ~/.vim/bundle/name
     :UseVimball ~/.vim/bundle/name
 
+> Why don't my plugins load when I use Vim sessions?
+
+Vim sessions default to capturing all global options, which includes the
+`'runtimepath'` that pathogen.vim manipulates.  This can cause other problems
+too, so I recommend turning that behavior off:
+
+    set sessionoptions-=options
+
 ## Contributing
 
 If your [commit message sucks](http://stopwritingramblingcommitmessages.com/),

autoload/pathogen.vim

@@ -1,11 +1,11 @@
 " pathogen.vim - path option manipulation
 " Maintainer:   Tim Pope <http://tpo.pe/>
-" Version:      2.1
+" Version:      2.3
 
 " Install in ~/.vim/autoload (or ~\vimfiles\autoload).
 "
 " For management of individually installed plugins in ~/.vim/bundle (or
-" ~\vimfiles\bundle), adding `call pathogen#infect()` to the top of your
+" ~\vimfiles\bundle), adding `execute pathogen#infect()` to the top of your
 " .vimrc is the only other setup necessary.
 "
 " The API is documented inline below.  For maximum ease of reading,
@@ -16,32 +16,25 @@ if exists("g:loaded_pathogen") || &cp
 endif
 let g:loaded_pathogen = 1
 
-function! s:warn(msg)
-  if &verbose
-    echohl WarningMsg
-    echomsg a:msg
-    echohl NONE
-  endif
-endfunction
-
 " Point of entry for basic default usage.  Give a relative path to invoke
-" pathogen#incubate() (defaults to "bundle/{}"), or an absolute path to invoke
+" pathogen#interpose() (defaults to "bundle/{}"), or an absolute path to invoke
 " pathogen#surround().  For backwards compatibility purposes, a full path that
 " does not end in {} or * is given to pathogen#runtime_prepend_subdirectories()
 " instead.
 function! pathogen#infect(...) abort " {{{1
-  let path = a:0 ? a:1 : 'bundle/{}'
-  if path =~# '^[^\\/]\+$'
-    call s:warn('Change pathogen#infect('.string(path).') to pathogen#infect('.string(path.'/{}').')')
-    call pathogen#incubate(path . '/{}')
-  elseif path =~# '^[^\\/]\+[\\/]\%({}\|\*\)$'
-    call pathogen#incubate(path)
-  elseif path =~# '[\\/]\%({}\|\*\)$'
-    call pathogen#surround(path)
-  else
-    call s:warn('Change pathogen#infect('.string(path).') to pathogen#infect('.string(path.'/{}').')')
-    call pathogen#surround(path . '/{}')
-  endif
+  for path in a:0 ? filter(reverse(copy(a:000)), 'type(v:val) == type("")') : ['bundle/{}']
+    if path =~# '^[^\\/]\+$'
+      call s:warn('Change pathogen#infect('.string(path).') to pathogen#infect('.string(path.'/{}').')')
+      call pathogen#interpose(path . '/{}')
+    elseif path =~# '^[^\\/]\+[\\/]\%({}\|\*\)$'
+      call pathogen#interpose(path)
+    elseif path =~# '[\\/]\%({}\|\*\)$'
+      call pathogen#surround(path)
+    else
+      call s:warn('Change pathogen#infect('.string(path).') to pathogen#infect('.string(path.'/{}').')')
+      call pathogen#surround(path . '/{}')
+    endif
+  endfor
   call pathogen#cycle_filetype()
   return ''
 endfunction " }}}1
@@ -85,6 +78,122 @@ function! pathogen#legacyjoin(...) abort " {{{1
   return call('pathogen#join',[1] + a:000)
 endfunction " }}}1
 
+" Turn filetype detection off and back on again if it was already enabled.
+function! pathogen#cycle_filetype() " {{{1
+  if exists('g:did_load_filetypes')
+    filetype off
+    filetype on
+  endif
+endfunction " }}}1
+
+" Check if a bundle is disabled.  A bundle is considered disabled if its
+" basename or full name is included in the list g:pathogen_disabled.
+function! pathogen#is_disabled(path) abort " {{{1
+  let sep = pathogen#slash()
+  let blacklist = get(g:, 'pathogen_blacklist', get(g:, 'pathogen_disabled', []))
+  return index(blacklist, fnamemodify(a:path, ':t')) != -1 || index(blacklist, a:path) != -1
+endfunction "}}}1
+
+" Prepend the given directory to the runtime path and append its corresponding
+" after directory.  If the directory is already included, move it to the
+" outermost position.  Wildcards are added as is.  Ending a path in /{} causes
+" all subdirectories to be added (except those in g:pathogen_disabled).
+function! pathogen#surround(path) abort " {{{1
+  let sep = pathogen#slash()
+  let rtp = pathogen#split(&rtp)
+  if a:path =~# '[\\/]{}$'
+    let path = fnamemodify(a:path[0:-4], ':p:s?[\\/]\=$??')
+    let before = filter(pathogen#glob_directories(path.sep.'*'), '!pathogen#is_disabled(v:val)')
+    let after  = filter(reverse(pathogen#glob_directories(path.sep."*".sep."after")), '!pathogen#is_disabled(v:val[0:-7])')
+    call filter(rtp,'v:val[0:strlen(path)-1] !=# path')
+  else
+    let path = fnamemodify(a:path, ':p:s?[\\/]\=$??')
+    let before = [path]
+    let after = [path . sep . 'after']
+    call filter(rtp, 'index(before + after, v:val) == -1')
+  endif
+  let &rtp = pathogen#join(before, rtp, after)
+  return &rtp
+endfunction " }}}1
+
+" For each directory in the runtime path, add a second entry with the given
+" argument appended.  If the argument ends in '/{}', add a separate entry for
+" each subdirectory.
+function! pathogen#interpose(name) abort " {{{1
+  let sep = pathogen#slash()
+  let name = a:name
+  if has_key(s:done_bundles, name)
+    return ""
+  endif
+  let s:done_bundles[name] = 1
+  let list = []
+  for dir in pathogen#split(&rtp)
+    if dir =~# '\<after$'
+      if name =~# '{}$'
+        let list +=  filter(pathogen#glob_directories(substitute(dir,'after$',name[0:-3],'').'*'.sep.'after'), '!pathogen#is_disabled(v:val[0:-7])') + [dir]
+      else
+        let list += [dir, substitute(dir, 'after$', '', '') . name . sep . 'after']
+      endif
+    else
+      if name =~# '{}$'
+        let list +=  [dir] + filter(pathogen#glob_directories(dir.sep.name[0:-3].'*'), '!pathogen#is_disabled(v:val)')
+      else
+        let list += [dir . sep . name, dir]
+      endif
+    endif
+  endfor
+  let &rtp = pathogen#join(pathogen#uniq(list))
+  return 1
+endfunction
+
+let s:done_bundles = {}
+
+" }}}1
+
+" Invoke :helptags on all non-$VIM doc directories in runtimepath.
+function! pathogen#helptags() abort " {{{1
+  let sep = pathogen#slash()
+  for glob in pathogen#split(&rtp)
+    for dir in map(split(glob(glob), "\n"), 'v:val.sep."/doc/".sep')
+      if (dir)[0 : strlen($VIMRUNTIME)] !=# $VIMRUNTIME.sep && filewritable(dir) == 2 && !empty(split(glob(dir.'*.txt'))) && (!filereadable(dir.'tags') || filewritable(dir.'tags'))
+        silent! execute 'helptags' pathogen#fnameescape(dir)
+      endif
+    endfor
+  endfor
+endfunction " }}}1
+
+command! -bar Helptags :call pathogen#helptags()
+
+" Execute the given command.  This is basically a backdoor for --remote-expr.
+function! pathogen#execute(...) abort " {{{1
+  for command in a:000
+    execute command
+  endfor
+  return ''
+endfunction " }}}1
+
+" Section: Unofficial
+
+" \ on Windows unless shellslash is set, / everywhere else.
+function! pathogen#slash() abort " {{{1
+  return !exists("+shellslash") || &shellslash ? '/' : '\'
+endfunction " }}}1
+
+function! pathogen#separator() abort " {{{1
+  return pathogen#slash()
+endfunction " }}}1
+
+" Convenience wrapper around glob() which returns a list.
+function! pathogen#glob(pattern) abort " {{{1
+  let files = split(glob(a:pattern),"\n")
+  return map(files,'substitute(v:val,"[".pathogen#slash()."/]$","","")')
+endfunction "}}}1
+
+" Like pathogen#glob(), only limit the results to directories.
+function! pathogen#glob_directories(pattern) abort " {{{1
+  return filter(pathogen#glob(a:pattern),'isdirectory(v:val)')
+endfunction "}}}1
+
 " Remove duplicates from a list.
 function! pathogen#uniq(list) abort " {{{1
   let i = 0
@@ -103,135 +212,15 @@ function! pathogen#uniq(list) abort " {{{1
   return a:list
 endfunction " }}}1
 
-" \ on Windows unless shellslash is set, / everywhere else.
-function! pathogen#separator() abort " {{{1
-  return !exists("+shellslash") || &shellslash ? '/' : '\'
-endfunction " }}}1
-
-" Convenience wrapper around glob() which returns a list.
-function! pathogen#glob(pattern) abort " {{{1
-  let files = split(glob(a:pattern),"\n")
-  return map(files,'substitute(v:val,"[".pathogen#separator()."/]$","","")')
-endfunction "}}}1
-
-" Like pathogen#glob(), only limit the results to directories.
-function! pathogen#glob_directories(pattern) abort " {{{1
-  return filter(pathogen#glob(a:pattern),'isdirectory(v:val)')
-endfunction "}}}1
-
-" Turn filetype detection off and back on again if it was already enabled.
-function! pathogen#cycle_filetype() " {{{1
-  if exists('g:did_load_filetypes')
-    filetype off
-    filetype on
-  endif
-endfunction " }}}1
-
-" Check if a bundle is disabled.  A bundle is considered disabled if it ends
-" in a tilde or its basename or full name is included in the list
-" g:pathogen_disabled.
-function! pathogen#is_disabled(path) " {{{1
-  if a:path =~# '\~$'
-    return 1
-  elseif !exists("g:pathogen_disabled")
-    return 0
-  endif
-  let sep = pathogen#separator()
-  let blacklist = g:pathogen_disabled
-  return index(blacklist, strpart(a:path, strridx(a:path, sep)+1)) != -1 && index(blacklist, a:path) != 1
-endfunction "}}}1
-
-" Prepend the given directory to the runtime path and append its corresponding
-" after directory.  If the directory is already included, move it to the
-" outermost position.  Wildcards are added as is.  Ending a path in /{} causes
-" all subdirectories to be added (except those in g:pathogen_disabled).
-function! pathogen#surround(path) abort " {{{1
-  let sep = pathogen#separator()
-  let rtp = pathogen#split(&rtp)
-  if a:path =~# '[\\/]{}$'
-    let path = fnamemodify(a:path[0:-4], ':p:s?[\\/]\=$??')
-    let before = filter(pathogen#glob_directories(path.sep.'*'), '!pathogen#is_disabled(v:val)')
-    let after  = filter(reverse(pathogen#glob_directories(path.sep."*".sep."after")), '!pathogen#is_disabled(v:val[0:-7])')
-    call filter(rtp,'v:val[0:strlen(path)-1] !=# path')
+" Backport of fnameescape().
+function! pathogen#fnameescape(string) abort " {{{1
+  if exists('*fnameescape')
+    return fnameescape(a:string)
+  elseif a:string ==# '-'
+    return '\-'
   else
-    let path = fnamemodify(a:path, ':p:s?[\\/]\=$??')
-    let before = [path]
-    let after = [path . sep . 'after']
-    call filter(rtp, 'index(before + after, v:val) == -1')
+    return substitute(escape(a:string," \t\n*?[{`$\\%#'\"|!<"),'^[+>]','\\&','')
   endif
-  let &rtp = pathogen#join(before, rtp, after)
-  return &rtp
-endfunction " }}}1
-
-" Prepend all subdirectories of path to the rtp, and append all 'after'
-" directories in those subdirectories.  Deprecated.
-function! pathogen#runtime_prepend_subdirectories(path) " {{{1
-  call s:warn('Change pathogen#runtime_prepend_subdirectories('.string(source_path).') to pathogen#surround('.string(source_path.'/{}').')')
-  return pathogen#surround(a:path . pathogen#separator() . '{}')
-endfunction " }}}1
-
-" For each directory in the runtime path, add a second entry with the given
-" argument appended.  If the argument ends in '/{}', add a separate entry for
-" each subdirectory.  The default argument is 'bundle/{}', which means that
-" .vim/bundle/*, $VIM/vimfiles/bundle/*, $VIMRUNTIME/bundle/*,
-" $VIM/vim/files/bundle/*/after, and .vim/bundle/*/after will be added (on
-" UNIX).
-function! pathogen#incubate(...) abort " {{{1
-  let sep = pathogen#separator()
-  let name = a:0 ? a:1 : 'bundle/{}'
-  if "\n".s:done_bundles =~# "\\M\n".name."\n"
-    return ""
-  endif
-  let s:done_bundles .= name . "\n"
-  let list = []
-  for dir in pathogen#split(&rtp)
-    if dir =~# '\<after$'
-      if name =~# '{}$'
-        let list +=  filter(pathogen#glob_directories(substitute(dir,'after$',name[0:-3],'').'*[^~]'.sep.'after'), '!pathogen#is_disabled(v:val[0:-7])') + [dir]
-      else
-        let list += [dir, substitute(dir, 'after$', '', '') . name . sep . 'after']
-      endif
-    else
-      if name =~# '{}$'
-        let list +=  [dir] + filter(pathogen#glob_directories(dir.sep.name[0:-3].'*[^~]'), '!pathogen#is_disabled(v:val)')
-      else
-        let list += [dir . sep . name, dir]
-      endif
-    endif
-  endfor
-  let &rtp = pathogen#join(pathogen#uniq(list))
-  return 1
-endfunction " }}}1
-
-" Deprecated alias for pathogen#incubate().
-function! pathogen#runtime_append_all_bundles(...) abort " {{{1
-  call s:warn('Change pathogen#runtime_append_all_bundles('.string(source_path).') to pathogen#incubate('.string(source_path.'/{}').')')
-  return call('pathogen#incubate', map(copy(a:000, 'v:val . "/{}"'))
-endfunction
-
-let s:done_bundles = ''
-" }}}1
-
-" Invoke :helptags on all non-$VIM doc directories in runtimepath.
-function! pathogen#helptags() abort " {{{1
-  let sep = pathogen#separator()
-  for glob in pathogen#split(&rtp)
-    for dir in split(glob(glob), "\n")
-      if (dir.sep)[0 : strlen($VIMRUNTIME)] !=# $VIMRUNTIME.sep && filewritable(dir.sep.'doc') == 2 && !empty(filter(split(glob(dir.sep.'doc'.sep.'*'),"\n>"),'!isdirectory(v:val)')) && (!filereadable(dir.sep.'doc'.sep.'tags') || filewritable(dir.sep.'doc'.sep.'tags'))
-        helptags `=dir.'/doc'`
-      endif
-    endfor
-  endfor
-endfunction " }}}1
-
-command! -bar Helptags :call pathogen#helptags()
-
-" Execute the given command.  This is basically a backdoor for --remote-expr.
-function! pathogen#execute(...) abort " {{{1
-  for command in a:000
-    execute command
-  endfor
-  return ''
 endfunction " }}}1
 
 " Like findfile(), but hardcoded to use the runtimepath.
@@ -245,15 +234,35 @@ function! pathogen#runtime_findfile(file,count) abort "{{{1
   endif
 endfunction " }}}1
 
-" Backport of fnameescape().
-function! pathogen#fnameescape(string) abort " {{{1
-  if exists('*fnameescape')
-    return fnameescape(a:string)
-  elseif a:string ==# '-'
-    return '\-'
+" Section: Deprecated
+
+function! s:warn(msg)
+  echohl WarningMsg
+  echomsg a:msg
+  echohl NONE
+endfunction
+
+" Prepend all subdirectories of path to the rtp, and append all 'after'
+" directories in those subdirectories.  Deprecated.
+function! pathogen#runtime_prepend_subdirectories(path) " {{{1
+  call s:warn('Change pathogen#runtime_prepend_subdirectories('.string(a:path).') to pathogen#infect('.string(a:path.'/{}').')')
+  return pathogen#surround(a:path . pathogen#slash() . '{}')
+endfunction " }}}1
+
+function! pathogen#incubate(...) abort " {{{1
+  let name = a:0 ? a:1 : 'bundle/{}'
+  call s:warn('Change pathogen#incubate('.(a:0 ? string(a:1) : '').') to pathogen#infect('.string(name).')')
+  return pathogen#interpose(name)
+endfunction " }}}1
+
+" Deprecated alias for pathogen#interpose().
+function! pathogen#runtime_append_all_bundles(...) abort " {{{1
+  if a:0
+    call s:warn('Change pathogen#runtime_append_all_bundles('.string(a:1).') to pathogen#infect('.string(a:1.'/{}').')')
   else
-    return substitute(escape(a:string," \t\n*?[{`$\\%#'\"|!<"),'^[+>]','\\&','')
+    call s:warn('Change pathogen#runtime_append_all_bundles() to pathogen#infect()')
   endif
+  return pathogen#interpose(a:0 ? a:1 . '/{}' : 'bundle/{}')
 endfunction " }}}1
 
 if exists(':Vedit')
@@ -284,7 +293,7 @@ function! s:find(count,cmd,file,lcd) " {{{1
 endfunction " }}}1
 
 function! s:Findcomplete(A,L,P) " {{{1
-  let sep = pathogen#separator()
+  let sep = pathogen#slash()
   let cheats = {
         \'a': 'autoload',
         \'d': 'doc',