Commit Graph

503 Commits

Author SHA1 Message Date
micbou
efdf6e034d
Instruct users to install MacVim with Homebrew
Replace Mac and Mac OS X with macOS and remove outdated entries about
Homebrew in the FAQ.
2019-05-05 13:32:41 +02:00
micbou
2708c6210a
Increase Clang requirement to 8.0.0 in the docs 2019-04-27 22:06:04 +02:00
micbou
8b07bd14b8
Add GoToType and GoToImplementation for Java in the docs 2019-04-27 22:04:59 +02:00
micbou
1efcfe4c48
Instruct installing Visual Studio Build Tools 2017
Visual Studio Build Tools is sufficient to build YCM. Version 2019 is
not yet supported.
2019-04-24 00:13:10 +02:00
micbou
65927fcd3d
Fix bold rendering issue in docs
Text is not rendered in bold because of the asterisk. Instead of
escaping the character, change the text to something more in line with
the other bullet points.
2019-04-06 01:27:15 +02:00
micbou
a47940d468
Fix Clangd link in docs 2019-03-17 21:02:45 +01:00
zzbot
299f8e48e7
Auto merge of #3325 - kadircet:update_clangd_docs, r=micbou
[READY] Update docs to represent new use_clangd flag

After merge of Valloric/ycmd#1191, `use_clangd` option has changed to binary, this patch updates docs to represent that change.

Needs to be merged after `third_party/ycmd` is updated to contain that PR.

<!-- 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/3325)
<!-- Reviewable:end -->
2019-03-14 06:48:15 -07:00
zzbot
66cd93e96f
Auto merge of #3316 - micbou:command-line-window, r=micbou
[READY] Allow completion in the command-line window

This implements @puremourning's suggestion from https://github.com/Valloric/YouCompleteMe/pull/1415#issuecomment-460197058 and adds an entry in the FAQ on how to override the `TAB` mapping in the command-line window. Since the `CmdwinEnter` event is triggered instead of `BufEnter` in that window, the `s:OnBufferEnter` function is called for that event too. Also, the contents of that window are empty when the filetype is set the first time so we ignore the `FileType` event in that window. Finally, the `qf` filetype is removed from the `g:ycm_filetype_blacklist` option since the quickfix window is always ignored.

This needs testing as these changes may not work well with plugins that create special buffers. We may have to blacklist the filetype of these buffers.

<!-- 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/3316)
<!-- Reviewable:end -->
2019-03-05 13:33:39 -08:00
zzbot
443356132e
Auto merge of #3315 - weirane:go-install-doc, r=micbou
Update Go's part in full installation guide

# PR Prelude

Thank you for working on YCM! :)

**Please complete these steps and check these boxes (by putting an `x` inside
the brackets) _before_ filing your PR:**

- [x] I have read and understood YCM's [CONTRIBUTING][cont] document.
- [x] I have read and understood YCM's [CODE_OF_CONDUCT][code] document.
- [x] I have included tests for the changes in my PR. If not, I have included a
  rationale for why I haven't.
- [x] **I understand my PR may be closed if it becomes obvious I didn't
  actually perform all of these steps.**

# Why this change is necessary and useful

- The original installation guide missed `go build` in `godef`'s directory, relating issue [here](https://github.com/Valloric/YouCompleteMe/issues/3071#issuecomment-403213723).
- The path of `gocode` and `godef` has been changed, update them in the doc.

I have tested this guide on my Manjaro laptop and it works fine, my go version is `1.11.4`.

(Since the path is too long, the vim help doc looks kind of ugly, maybe the formatting or the
path's presenting way should be changed so that it looks better. I used the `gq` command
in vim and it gave me this.)

[cont]: https://github.com/Valloric/YouCompleteMe/blob/master/CONTRIBUTING.md
[code]: https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md

<!-- 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/3315)
<!-- Reviewable:end -->
2019-02-25 06:40:11 -08:00
Wang Ruochen
c5b5d50056 update go's part in full installation guide 2019-02-19 17:03:16 +00:00
Kadir Cetinkaya
753d39f8da Update docs to represent new use_clangd flag 2019-02-18 16:38:09 +01:00
zzbot
032281307d
Auto merge of #3296 - kadircet:master, r=micbou
[READY] Add instructions for clangd into README

# PR Prelude

Thank you for working on YCM! :)

**Please complete these steps and check these boxes (by putting an `x` inside
the brackets) _before_ filing your PR:**

- [x] I have read and understood YCM's [CONTRIBUTING][cont] document.
- [x] I have read and understood YCM's [CODE_OF_CONDUCT][code] document.
- [ ] I have included tests for the changes in my PR. If not, I have included a
  rationale for why I haven't.
- [x] **I understand my PR may be closed if it becomes obvious I didn't
  actually perform all of these steps.**

# Why this change is necessary and useful

clangd-based completer has been introduced into ycmd for a while now. I believe it is time to let users know about it as well. We are also updating clangd's docs and it would be nice to point people using vim into YCM docs for integration. You can see the patch for that one in https://reviews.llvm.org/D56718.

Also you can have a look at the end product of the changes at https://kadircet.github.io/YouCompleteMe

[cont]: https://github.com/Valloric/YouCompleteMe/blob/master/CONTRIBUTING.md
[code]: https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md

<!-- 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/3296)
<!-- Reviewable:end -->
2019-02-16 01:54:52 -08:00
Kadir Cetinkaya
f9b26a066c Add clangd into docs 2019-02-16 10:46:29 +01:00
micbou
f3ce1d12bd
Allow completion in the command-line window 2019-02-05 20:48:06 +01:00
zzbot
c25e449f4e
Auto merge of #3312 - micbou:update-ycmd, r=bstaletic
[READY] Update ycmd

Include the following changes:

 - PR Valloric/ycmd#1095: allow users to configure LSP servers through extra conf;
 - PR Valloric/ycmd#1118: add Clangd completer;
 - PR Valloric/ycmd#1130: do not default to 32-bit when downloading libclang;
 - PR Valloric/ycmd#1132: update requests;
 - PR Valloric/ycmd#1149: do not include Clangd with `--all`;
 - PR Valloric/ycmd#1151: add `GetType` command to Python completer;
 - PR Valloric/ycmd#1152: update Boost to 1.69;
 - PR Valloric/ycmd#1153: only detail filtered candidates in Python completer;
 - PR Valloric/ycmd#1154: include signature to Python candidates;
 - PR Valloric/ycmd#1155: only detail filtered candidates in TypeScript completer;
 - PR Valloric/ycmd#1156: update Jedi to 0.13.2;
 - PR Valloric/ycmd#1157: only detail filtered candidates in Go completer;
 - PR Valloric/ycmd#1161: only resolve filtered candidates in LSP completer;
 - PR Valloric/ycmd#1164: do not find CMake and Python if not needed;
 - PR Valloric/ycmd#1167: do not read LSP settings on every file parse;
 - PR Valloric/ycmd#1172: fix system headers search on macOS;
 - PR Valloric/ycmd#1174: report Java server startup status correctly;
 - PR Valloric/ycmd#1177: make LSP debug info consistent;
 - PR Valloric/ycmd#1178: improve LSP project directory detection;
 - PR Valloric/ycmd#1179: determine simple subcommands automatically in LSP completer;
 - PR Valloric/ycmd#1181: fix LSP server startup when UnknownExtraConf is thrown.

<!-- 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/3312)
<!-- Reviewable:end -->
2019-01-27 23:33:26 -08:00
zzbot
10f7dea123
Auto merge of #3302 - micbou:highlight-lines-without-gutter, r=puremourning
[READY] Add instruction on how to highlight lines without Vim gutter

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

<!-- 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/3302)
<!-- Reviewable:end -->
2019-01-27 12:46:23 -08:00
micbou
9bf53fba7e
Add GetType subcommand for Python in docs
Be consistent in the order of features between languages.
2019-01-27 16:16:41 +01:00
micbou
c8530d0622
Add instruction on how to highlight lines without Vim gutter 2019-01-20 15:16:55 +01:00
micbou
1c11508782
Update g:ycm_max_diagnostics_to_display docs 2019-01-20 13:16:54 +01:00
zzbot
7997fc5536
Auto merge of #3276 - micbou:vim-win-download-url, r=micbou
[READY] Update Vim installer URL for Windows

There is now [a 64-bit Vim installer for Windows](https://github.com/vim/vim-win32-installer/releases).

<!-- 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/3276)
<!-- Reviewable:end -->
2018-12-23 11:03:51 -08:00
micbou
abd8c213cf
Remove vim-nerdtree-tabs from FAQ
The vim-nerdtree-tabs plugin fixed the issue preventing the VimLeave
event from triggering.
2018-12-23 11:41:56 +01:00
micbou
ace4afad38
Update Vim installer URL for Windows 2018-12-21 16:34:27 +01:00
micbou
ee6756bdf4
Update FAQ entry about outdated libclang 2018-12-11 20:19:32 +01:00
micbou
17c9da60f6
Increase libclang version requirement in docs 2018-11-19 19:08:45 +01:00
micbou
76aa22886f
Update TypeScript instructions in docs 2018-11-17 14:29:01 +01:00
micbou
4b4f678bef
Support completion FixIts for C-family languages 2018-11-17 14:29:00 +01:00
Santosh Kumar
a6f0fb2cbd removes 'below' from text to reduce confusion 2018-11-01 21:34:46 +05:30
micbou
0ac80ab619
Update docs about the default version of Python used for completion
Jedi now picks the version of Python running the ycmd server.
2018-10-08 00:05:22 +02:00
zzbot
5c722bbfbb
Auto merge of #3161 - micbou:completer-command-ignore-ft-option, r=puremourning
[READY] Ignore ft= argument from YcmCompleter command

The `ft=` argument of the `YcmCompleter` command is supposed to allow users to specify a completer when running a command. However, this was broken a long time ago in commit 29bb90a6b4. Only the `ycm:ident` value is still supported but it serves no purpose because the identifier completer doesn't define commands. Ignore completely the `ft=` argument and move the logic to the Python layer. Remove the argument from the documentation.

<!-- 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/3161)
<!-- Reviewable:end -->
2018-10-07 12:21:39 -07:00
micbou
d2ee69d521
Remove ncurses-compat-libs dependency for Fedora
The downloaded libclang on Linux does not depend on terminfo anymore.
2018-10-07 03:24:33 +02:00
micbou
9957e7ba0a
Update semantic triggers in documentation 2018-10-07 03:24:32 +02:00
micbou
bdc3a66488
Ignore ft= argument from YcmCompleter command
Only the "ycm:ident" value of the ft= argument in the YcmCompleter
command is working. This value forces the use of the identifier
completer which serve no purpose because this completer doesn't define
commands. Ignore completely the ft= argument and move the logic to the
Python layer.
2018-09-28 01:12:23 +02:00
micbou
fa6d089ea9
Update Java links in documentation
Fix pom.xml broken link and use permanent links.
2018-09-20 09:17:09 +02:00
zzbot
9e381ade46
Auto merge of #3140 - micbou:merge-linux-docs, r=Valloric
[READY] Merge Linux distributions instructions

As proposed in https://github.com/Valloric/YouCompleteMe/pull/3055#pullrequestreview-149835682, merge the Ubuntu Linux x64 and Fedora Linux x64 instructions into one section for Linux 64-bit. The result can be seen [here](https://github.com/micbou/YouCompleteMe/tree/merge-linux-docs#linux-64-bit).

I confirmed the required packages for Fedora are `gcc-c++`, `cmake`, `python3-devel` (and `ncurses-compat-libs` for C/C++) by installing the distribution in a VM.

Closes #3069.

<!-- 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/3140)
<!-- Reviewable:end -->
2018-09-19 21:19:56 -07:00
micbou
aaa94ba9c9
Merge Linux distributions instructions 2018-09-05 17:37:15 +02:00
micbou
7b3a4aaf04
Add CUDA to C-family languages in documentation 2018-08-19 21:27:21 +02:00
zzbot
a688da3b96
Auto merge of #3120 - micbou:goto-modifiers-version, r=micbou
[READY] Only use command modifiers if available

Command modifiers (see `:h mods`) were added in [Vim 7.4.1898](63a60ded3f (diff-28587d36c24b61c33d4d01601f5974ee)) while we support 7.4.1578 and later.

Fixes https://github.com/Valloric/YouCompleteMe/issues/3105.

<!-- 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/3120)
<!-- Reviewable:end -->
2018-08-19 11:34:44 -07:00
zzbot
9ce35aee91
Auto merge of #3113 - micbou:python-docs, r=micbou
[READY] Update Python documentation and add extra conf file

This PR updates the Python docs and adds a `.ycm_extra_conf.py` file to be able to complete third-party packages in YCM code.

<!-- 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/3113)
<!-- Reviewable:end -->
2018-08-19 10:16:20 -07:00
micbou
2f93af0001
Update Python documentation and add extra conf file 2018-08-19 15:31:37 +02:00
micbou
959d0c4c5f
Only use command modifiers if available
Command modifiers were added in Vim 7.4.1898.
2018-08-14 13:52:25 +02:00
micbou
713515167f
Add entry in FAQ about automatic import insertion breaking undo 2018-08-09 00:42:56 +02:00
zzbot
15362d9cb8
Auto merge of #3089 - micbou:tsserver-javascript, r=Valloric
[READY] Update JavaScript support and documentation

This updates the documentation with the proposed changes in https://github.com/Valloric/ycmd/pull/1036#issuecomment-397234687. The Tern instructions are moved to [this wiki page](https://github.com/Valloric/YouCompleteMe/wiki/JavaScript-Semantic-Completion-through-Tern). JavaScript is added to the list of supported filetypes for diagnostics and completion fixits.

<!-- 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/3089)
<!-- Reviewable:end -->
2018-07-25 14:02:12 -07:00
zzbot
1e9c59abfa
Auto merge of #3091 - micbou:completer-command-mods, r=Valloric
[READY] Support modifiers for GoTo commands

This PR allows users to customize how a window is split when running the `GoTo*` commands by prefixing them with the modifiers `:aboveleft`, `:belowright`, `:botright`, etc. (see `:h mods` for the complete list). For instance, to split a window vertically at the right of the screen, one could do:
```viml
:botright vertical YcmCompleter GoTo
```
The `'horizontal-split'` and `'vertical-split'` values of the `g:ycm_goto_buffer_command` option are replaced by `'split'` since a vertical split can be obtained by prefixing the `:vertical` modifier. Those values are still kept for backward compatibility.

A new value is added `'split-or-existing-window'` that is equivalent to `new-or-existing-tab` when the `:tab` modifier is used. Without the `:tab` modifier, the `GoTo*` commands only jump to an existing window if that window is in the current tab page.

Closes https://github.com/Valloric/YouCompleteMe/pull/3090.

<!-- 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/3091)
<!-- Reviewable:end -->
2018-07-25 13:46:18 -07:00
micbou
4e3ae95e9f
Update JavaScript support and documentation 2018-07-25 22:15:01 +02:00
micbou
52c022708c
Update C-family documentation 2018-07-25 20:45:57 +02:00
micbou
87702559f3
Support modifiers for GoTo commands 2018-07-24 18:07:41 +02:00
micbou
31b6d9426a
Add g:ycm_filepath_blacklist option to documentation 2018-07-24 02:14:38 +02:00
micbou
a97bff78d6
Fix typos in documentation 2018-06-10 18:11:17 +02:00
zzbot
c9ff217737
Auto merge of #3032 - micbou:msvc-12-docs, r=micbou
[READY] Remove Visual Studio 12 generator from the docs

Forgot to remove this CMake generator in commit 9392f7fd61.

<!-- 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/3032)
<!-- Reviewable:end -->
2018-06-02 11:33:48 -07:00
zzbot
17f28c68ff
Auto merge of #3013 - bstaletic:anaconda_faq, r=puremourning
[READY] Anaconda python FAQ

# PR Prelude

Thank you for working on YCM! :)

**Please complete these steps and check these boxes (by putting an `x` inside
the brackets) _before_ filing your PR:**

- [x] I have read and understood YCM's [CONTRIBUTING][cont] document.
- [x] I have read and understood YCM's [CODE_OF_CONDUCT][code] document.
- [x] I have included tests for the changes in my PR. If not, I have included a
  rationale for why I haven't.
- [x] **I understand my PR may be closed if it becomes obvious I didn't
  actually perform all of these steps.**

# Why this change is necessary and useful

Since the latest anaconda works with YCM, let's just state that it is not supported in the README.

[Please explain **in detail** why the changes in this PR are needed.]

[cont]: https://github.com/Valloric/YouCompleteMe/blob/master/CONTRIBUTING.md
[code]: https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md

<!-- 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/3013)
<!-- Reviewable:end -->
2018-06-02 09:39:54 -07:00