summaryrefslogtreecommitdiffstats
path: root/tools/vim
diff options
context:
space:
mode:
authorasanka <asanka@chromium.org>2015-06-03 11:40:37 -0700
committerCommit bot <commit-bot@chromium.org>2015-06-03 18:41:09 +0000
commit385a4faa97cdad479f941c4f5527f6b421cf605d (patch)
tree291d023b746055c77eb2d8ef0c29195350aaa00c /tools/vim
parente3c37b31e826cd26005fbedb1227984d1711aae3 (diff)
downloadchromium_src-385a4faa97cdad479f941c4f5527f6b421cf605d.zip
chromium_src-385a4faa97cdad479f941c4f5527f6b421cf605d.tar.gz
chromium_src-385a4faa97cdad479f941c4f5527f6b421cf605d.tar.bz2
[Vim/YCM] Update instructions for setting up YouCompleteMe
Previous recommended workflow was to set g:ycm_global_ycm_extra_conf variable. Doing so would override any site specific gloabl YCM configuration. Instead the new instructions suggest a workflow for setting up Chromium's YCM configuration file so that it only applies to files within the Chromium checkout. R=eroman@chromium.org BUG=none Review URL: https://codereview.chromium.org/1161273006 Cr-Commit-Position: refs/heads/master@{#332653}
Diffstat (limited to 'tools/vim')
-rw-r--r--tools/vim/chromium.ycm_extra_conf.py19
1 files changed, 15 insertions, 4 deletions
diff --git a/tools/vim/chromium.ycm_extra_conf.py b/tools/vim/chromium.ycm_extra_conf.py
index 37f5a9d..5715e29 100644
--- a/tools/vim/chromium.ycm_extra_conf.py
+++ b/tools/vim/chromium.ycm_extra_conf.py
@@ -9,11 +9,22 @@
# 1. Install YCM [https://github.com/Valloric/YouCompleteMe]
# (Googlers should check out [go/ycm])
#
-# 2. Point to this config file in your .vimrc:
-# let g:ycm_global_ycm_extra_conf =
-# '<chrome_depot>/src/tools/vim/chromium.ycm_extra_conf.py'
+# 2. Create a symbolic link to this file called .ycm_extra_conf.py in the
+# directory above your Chromium checkout (i.e. next to your .gclient file).
#
-# 3. Profit
+# cd src
+# ln -rs tools/vim/chromium.ycm_extra_conf.py ../.ycm_extra_conf.py
+#
+# 3. (optional) Whitelist the .ycm_extra_conf.py from step #2 by adding the
+# following to your .vimrc:
+#
+# let g:ycm_extra_conf_globlist=['<path to .ycm_extra_conf.py>']
+#
+# You can also add other .ycm_extra_conf.py files you want to use to this
+# list to prevent excessive prompting each time you visit a directory
+# covered by a config file.
+#
+# 4. Profit
#
#
# Usage notes: