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

[micbou]

This issue has already been reported twice (#2403 and #2611) and is not something that we can fix on our side so we should mention it in the FAQ.

Closes #2611.

---

This change is 

[codecov-io]

Codecov Report

Merging #2639 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2639   +/-   ##
=======================================
  Coverage   87.67%   87.67%           
=======================================
  Files          19       19           
  Lines        1947     1947           
=======================================
  Hits         1707     1707           
  Misses        240      240

[Valloric]

with minor comment.

Thanks for the PR!

---

Review status: 0 of 2 files reviewed at latest revision, 1 unresolved discussion.

---

README.md, line 3027 at r1 (raw file):

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.

I would also add here that ycmd will shut itself down after a while if it receives no requests. This time can be configured (we should mention the option name).

So even in the cases where ycmd sticks around, it won't be for long.

Might also be a good idea to open an issue with the vim-nerdtree-tabs project.

---

Comments from Reviewable

[micbou]

Reviewed 1 of 2 files at r2.
Review status: 1 of 2 files reviewed at latest revision, 1 unresolved discussion.

---

README.md, line 3027 at r1 (raw file):

This time can be configured (we should mention the option name).

There is no option to configure it. Maybe 3 hours is a bit too long? We could reduce it to 1 hour or even 30 minutes given that we keep the server alive every 10 minutes.

Might also be a good idea to open an issue with the vim-nerdtree-tabs project.

See jistr/vim-nerdtree-tabs#76.

---

Comments from Reviewable

[bstaletic]

Just some minor questions, otherwise

---

Reviewed 2 of 2 files at r2.
Review status: all files reviewed at latest revision, 4 unresolved discussions, some commit checks failed.

---

README.md, line 3021 at r2 (raw file):

YCM does not shut down when I quit Vim

This is talking about ycmd not exiting. Shouldn't this line say ### ycmd does not shut down when I quit Vim?

---

doc/youcompleteme.txt, line 170 at r2 (raw file):

  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|

Same as the above. YCM or ycmd?

---

doc/youcompleteme.txt, line 3308 at r2 (raw file):

-------------------------------------------------------------------------------
                         *youcompleteme-ycm-does-not-shut-down-when-i-quit-vim*
YCM does not shut down when I quit Vim ~

Same as the above.

---

Comments from Reviewable

[micbou]

Reviewed 1 of 2 files at r1, 1 of 2 files at r2.
Review status: all files reviewed at latest revision, 4 unresolved discussions, some commit checks failed.

---

README.md, line 3021 at r2 (raw file):

Previously, bstaletic wrote…

This is talking about ycmd not exiting. Shouldn't this line say ### ycmd does not shut down when I quit Vim?

That's intentional. Users don't necessarily know about ycmd so when encountering the issue, they will look for YCM not shutting down, not for ycmd.

---

doc/youcompleteme.txt, line 170 at r2 (raw file):

Previously, bstaletic wrote…

Same as the above. YCM or ycmd?

This file is automatically generated from README.md using the html2vimdoc tool so you don't need to review it.

---

Comments from Reviewable

[bstaletic]

Review status: all files reviewed at latest revision, 2 unresolved discussions.

---

README.md, line 3021 at r2 (raw file):

Previously, micbou wrote…

That's intentional. Users don't necessarily know about ycmd so when encountering the issue, they will look for YCM not shutting down, not for ycmd.

I assumed it would be something like that. I remember that I wasn't quite sure what is ycmd when I started using YCM.

---

doc/youcompleteme.txt, line 170 at r2 (raw file):

Previously, micbou wrote…

This file is automatically generated from README.md using the html2vimdoc tool so you don't need to review it.

I knew one of the two files was automatically generateed. I just didn't know which.

---

Comments from Reviewable

[Valloric]

Review status: all files reviewed at latest revision, 2 unresolved discussions.

---

README.md, line 3027 at r1 (raw file):

Previously, micbou wrote…

This time can be configured (we should mention the option name).

There is no option to configure it. Maybe 3 hours is a bit too long? We could reduce it to 1 hour or even 30 minutes given that we keep the server alive every 10 minutes.

Might also be a good idea to open an issue with the vim-nerdtree-tabs project.

See jistr/vim-nerdtree-tabs#76.

Huh, I could have sworn we had an option for it.

Anyway, I'm fine with reducing it to 30 mins. We didn't use to have the heartbeat events so the value needed to be higher.

---

README.md, line 3021 at r2 (raw file):

Previously, bstaletic wrote…

I assumed it would be something like that. I remember that I wasn't quite sure what is ycmd when I started using YCM.

I noticed this too but I assumed @micbou used YCM on purpose for the exact reason he stated above.

---

Comments from Reviewable

[micbou]

Reviewed 3 of 3 files at r3.
Review status: all files reviewed at latest revision, 2 unresolved discussions.

---

README.md, line 3027 at r1 (raw file):

Previously, Valloric (Val Markovic) wrote…

Huh, I could have sworn we had an option for it.

Anyway, I'm fine with reducing it to 30 mins. We didn't use to have the heartbeat events so the value needed to be higher.

Done.

---

Comments from Reviewable

[bstaletic]

This seems ready, let's merge it.

@micbou Thanks for the PR.

@zzbot r=valloric

---

Review status: all files reviewed at latest revision, 2 unresolved discussions.

---

Comments from Reviewable

[zzbot]

📌 Commit 4e08cde has been approved by valloric

[zzbot]

⌛ Testing commit 4e08cde with merge 61b5aa7...

[zzbot]

☀️ Test successful - status-travis
Approved by: valloric
Pushing 61b5aa7 to master...