From 087edd735465b9ef21f2bb6c522dd8423f07d321 Mon Sep 17 00:00:00 2001 From: James Hogan Date: Tue, 7 Apr 2015 13:33:20 -0700 Subject: [PATCH] Two documentation fixes: 1. Removed trailing slash at end of rtp (runtimepath) parameter example. The code behaves such that there should not be a trailing slash; can very this easily by do a ":set runtimepath?" 2. Added a node that filetype plugins (which vim *assumes* will be located in $(runtimepath)/ftplugin/[filetype]*) should have the "ftplugin/[filetype]" part of the path excluded from the rtp parameter. For example, the vim-instant-markdown plugin (https://github.com/suan/vim-instant-markdown) will only work properly if rtp is set to "after", rather than "after/ftplugin/markdown". --- README.md | 3 ++- doc/vundle.txt | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 337e0b5..694526d 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,8 @@ Plugin 'file:///home/gmarik/path/to/plugin' " The sparkup vim script is in a subdirectory of this repo called vim. " Pass the path to set the runtimepath properly. - Plugin 'rstacruz/sparkup', {'rtp': 'vim/'} + " For filetype-based plugins, EXCLUDE the "ftplugin/[filetype]" part of the path. + Plugin 'rstacruz/sparkup', {'rtp': 'vim'} " Avoid a name conflict with L9 Plugin 'user/L9', {'name': 'newL9'} diff --git a/doc/vundle.txt b/doc/vundle.txt index 9a2670a..6d89153 100644 --- a/doc/vundle.txt +++ b/doc/vundle.txt @@ -93,7 +93,8 @@ more information. Plugin 'file:///home/gmarik/path/to/plugin' " The sparkup vim script is in a subdirectory of this repo called vim. " Pass the path to set the runtimepath properly. - Plugin 'rstacruz/sparkup', {'rtp': 'vim/'} + " For filetype-based plugins, EXCLUDE the "ftplugin/[filetype]" part of the path. + Plugin 'rstacruz/sparkup', {'rtp': 'vim'} " Avoid a name conflict with L9 Plugin 'user/L9', {'name': 'newL9'}