contrib/ycm_extra_conf.py (#6257)

- Remove some unnecessary code: IsHeaderFile is no longer required, as the logic
  to find flags to headers is now built into YCM
- Add function to make paths in flags absolute: It seems YCM is not correctly
  resolving paths in flags to consider `build` as the compiler working
  directory.
- Update documentation.

1 files changed, 13 insertions, 4 deletions

diff --git a/contrib/YouCompleteMe/README.md b/contrib/YouCompleteMe/README.md
index 0c07440a44..345a9d8d12 100644
--- a/contrib/YouCompleteMe/README.md
+++ b/contrib/YouCompleteMe/README.md
@@ -2,7 +2,9 @@
 
 ## What is this?
 
-This provides the code necessary to configure vim's YCM plugin to provide C semantic support (completion, go-to-definition, etc) for developers working on the Neovim project.
+This provides the code necessary to configure vim's YCM plugin to provide C
+semantic support (completion, go-to-definition, etc) for developers working on
+the Neovim project.
 
 ## Installation
 
@@ -13,10 +15,17 @@ Install [YouCompleteMe](https://github.com/Valloric/YouCompleteMe).
 ### Step 2
 
 ```bash
-cp contrib/YouCompleteMe/ycm_extra_conf.py src/.ycm_extra_conf.py
+cp contrib/YouCompleteMe/ycm_extra_conf.py .ycm_extra_conf.py
 echo .ycm_extra_conf.py >> .git/info/exclude
 make
+```
+
+Tip: to improve source code navigation, add something like this to your nvim
+configuration:
 
-(Add the following somewhere in your vimrc)
-autocmd FileType c nnoremap <buffer> <silent> <C-]> :YcmCompleter GoTo<cr>
+```vim
+au FileType c,cpp nnoremap <buffer> <c-]> :YcmCompleter GoTo<CR>
 ```
+
+And use `ctrl+]` when the cursor is positioned in a symbol to quickly jump to a
+definition or declaration.