Auto merge of #2639 - micbou:faq-ycm-shutdown, r=valloric

[READY] Add FAQ entry about YCM not shutting down when quitting Vim

This issue has already been reported twice (https://github.com/Valloric/YouCompleteMe/issues/2403 and https://github.com/Valloric/YouCompleteMe/issues/2611) and is not something that we can fix on our side so we should mention it in the FAQ.

Closes https://github.com/Valloric/YouCompleteMe/issues/2611.

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/2639)
<!-- Reviewable:end -->
This commit is contained in:
zzbot 2017-05-15 12:33:15 -07:00 committed by GitHub
commit 61b5aa76fe
3 changed files with 30 additions and 7 deletions

View File

@ -3018,6 +3018,15 @@ augroup load_ycm
augroup END
```
### YCM does not shut down when I quit Vim
YCM relies on the `VimLeave` event to shut down the [ycmd server][ycmd]. Some
plugins prevent this event from triggering by exiting Vim through an autocommand
without using the `nested` keyword (see `:h autocmd-nested`). One of these
plugins is [vim-nerdtree-tabs][]. You should identify which plugin is
responsible for the issue and report it to the plugin author. Note that when
this happens, [ycmd][] will automatically shut itself down after 30 minutes.
Contributor Code of Conduct
---------------------------
@ -3112,3 +3121,4 @@ This software is licensed under the [GPL v3 license][gpl].
[vim_win-python2.7.11-bug_workaround]: https://github.com/vim/vim-win32-installer/blob/a27bbdba9bb87fa0e44c8a00d33d46be936822dd/appveyor.bat#L86-L88
[gitter]: https://gitter.im/Valloric/YouCompleteMe
[ninja-compdb]: https://ninja-build.org/manual.html
[vim-nerdtree-tabs]: https://github.com/jistr/vim-nerdtree-tabs

View File

@ -167,6 +167,7 @@ attempt to load the C runtime library incorrectly.' |youcompleteme-when-i-start-
module could not be loaded" |youcompleteme-on-windows-i-get-e887-sorry-this-command-is-disabled-pythons-site-module-could-not-be-loaded|
34. I can't complete python packages in a virtual environment. |youcompleteme-i-cant-complete-python-packages-in-virtual-environment.|
35. I want to defer loading of YouCompleteMe until after Vim finishes booting |i-want-to-defer-loading-of-youcompleteme-until-after-vim-finishes-booting|
36. YCM does not shut down when I quit Vim |youcompleteme-ycm-does-not-shut-down-when-i-quit-vim|
12. Contributor Code of Conduct |youcompleteme-contributor-code-of-conduct|
13. Contact |youcompleteme-contact|
14. License |youcompleteme-license|
@ -3302,12 +3303,23 @@ In recent versions of Vim, you can install YCM in a folder under
\ | autocmd! load_ycm
augroup END
<
-------------------------------------------------------------------------------
*youcompleteme-ycm-does-not-shut-down-when-i-quit-vim*
YCM does not shut down when I quit Vim ~
YCM relies on the 'VimLeave' event to shut down the ycmd server [43]. Some
plugins prevent this event from triggering by exiting Vim through an
autocommand without using the 'nested' keyword (see ':h autocmd-nested'). One
of these plugins is vim-nerdtree-tabs [68]. You should identify which plugin is
responsible for the issue and report it to the plugin author. Note that when
this happens, ycmd [43] will automatically shut itself down after 30 minutes.
===============================================================================
*youcompleteme-contributor-code-of-conduct*
Contributor Code of Conduct ~
Please note that this project is released with a Contributor Code of Conduct
[68]. By participating in this project you agree to abide by its terms.
[69]. By participating in this project you agree to abide by its terms.
===============================================================================
*youcompleteme-contact*
@ -3317,7 +3329,7 @@ If you have questions about the plugin or need help, please join the Gitter
room [1] or use the ycm-users [62] mailing list.
If you have bug reports or feature suggestions, please use the issue tracker
[69].
[70].
The latest version of the plugin is available at
http://valloric.github.io/YouCompleteMe/.
@ -3328,7 +3340,7 @@ The author's homepage is http://val.markovic.io.
*youcompleteme-license*
License ~
This software is licensed under the GPL v3 license [70]. © 2015-2017
This software is licensed under the GPL v3 license [71]. © 2015-2017
YouCompleteMe contributors
===============================================================================
@ -3402,8 +3414,9 @@ References ~
[65] http://stackoverflow.com/questions/14552348/runtime-error-r6034-in-embedded-python-application/34696022
[66] https://github.com/vim/vim/issues/717
[67] https://github.com/vim/vim-win32-installer/blob/a27bbdba9bb87fa0e44c8a00d33d46be936822dd/appveyor.bat#L86-L88
[68] https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md
[69] https://github.com/Valloric/YouCompleteMe/issues?state=open
[70] http://www.gnu.org/copyleft/gpl.html
[68] https://github.com/jistr/vim-nerdtree-tabs
[69] https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md
[70] https://github.com/Valloric/YouCompleteMe/issues?state=open
[71] http://www.gnu.org/copyleft/gpl.html
vim: ft=help

View File

@ -99,7 +99,7 @@ CORE_PYTHON3_MESSAGE = (
CORE_OUTDATED_MESSAGE = (
'YCM core library too old; PLEASE RECOMPILE by running the install.py '
'script. See the documentation for more details.' )
SERVER_IDLE_SUICIDE_SECONDS = 10800 # 3 hours
SERVER_IDLE_SUICIDE_SECONDS = 1800 # 30 minutes
DIAGNOSTIC_UI_FILETYPES = set( [ 'cpp', 'cs', 'c', 'objc', 'objcpp',
'typescript' ] )
CLIENT_LOGFILE_FORMAT = 'ycm_'