Commit Graph

152 Commits

Author SHA1 Message Date
micbou
6b6f326ffc Update Vim documentation 2016-06-11 05:19:22 +02:00
Stefan VanBuren
a05c500bb9 Update vim documentation with html2vimdoc 2016-06-02 16:37:11 -04:00
micbou
4824b8fd4b Update Clang version in documentation 2016-04-07 11:16:01 +02:00
micbou
5a938ec82f Add TypeScript RefactorRename to documentation 2016-04-06 05:33:19 +02:00
Homu
1b76af4386 Auto merge of #2083 - puremourning:readme-pyenv, r=vheon
Add how to build python to avoid startup problems (in particular, pyenv)

# 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

I spent a while trying to find where I had written the instructions for building python with pyenv to work with YCM, then I thought the README was a good place for it.

ycmd must use pythons with `--enable-shared` or `--enable-framework` else boom.

[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="35" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/2083)
<!-- Reviewable:end -->
2016-03-27 03:28:18 +09:00
Homu
0648068b37 Auto merge of #2054 - vheon:rename-python-interpreter-options, r=Valloric
[READY] Rename ycmd python option

# 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

[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

As requested in https://github.com/Valloric/YouCompleteMe/issues/2052#issuecomment-195631106 I'm sending this PR. I've marked it as WIP because I've renamed only the `ycmd` option and that is because keeping the backward compatibility here was straight forward since is a client only option. For the jedihttp option instead I would like some opinion on how to procede: should we keep the backward compatibility here on the client or should we make the backward compatibility layer on the ycmd side? Keeping it here would be easier but it would mean that other clients should implement this theirself. Thoughts?

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="35" align="absmiddle" alt="Review on Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/2054)
<!-- Reviewable:end -->
2016-03-27 03:16:07 +09:00
Andrea Cedraro
9e6645f515 Rename ycmd python option
- Rename ycm_path_to_python_interpreter to ycm_ycmd_python_interpreter
- Keep ycm_path_to_python_interpreter backward compatible
2016-03-26 19:15:08 +01:00
Ben Jackson
366b11c7be Add how to build python to avoid startup problems (in particular, pyenv) 2016-03-26 15:24:47 +00:00
micbou
dbc2c08af9 Update Windows installation in README
Add instructions for Python 3 on Windows. Change link to Vim builds
for Windows. Always use a capital letter for Python.
2016-03-23 18:51:41 +01:00
micbou
c5cf60b7d3 Fix more confusing phrasing in README 2016-03-20 22:50:26 +01:00
Val Markovic
e8fa6e2350 Fix confusing phrasing in README
Fixes #2042
2016-03-09 20:00:05 -08:00
Homu
381b213271 Auto merge of #2035 - micbou:faq-import-error, r=Valloric
[READY] Fix multiline title entry in FAQ

Apparently, it is not possible to write a header on multiple lines using the `#` syntax in markdown, so we write it on one line.

Update the vim docs too.

<!-- Reviewable:start -->
[<img src="https://reviewable.io/review_button.svg" height="40" alt="Review on Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/2035)
<!-- Reviewable:end -->
2016-03-08 02:57:14 +09:00
micbou
0f10951bdf Fix title entry in FAQ 2016-03-07 17:00:33 +01:00
Ben Jackson
3b6b949bb3 Update README to include --all flag 2016-03-05 21:31:32 +00:00
micbou
df8a52671d Fix table of contents
Make headings and TOC entries have the same text.
Use Title Case for TOC entries.
Add "Miscellaneous commands" and "Functions" entries.
Set "And That's not all..." heading in bold instead.
Move "Diagnostic highlighting groups" to a third-level entry.
2016-02-27 18:43:59 +01:00
Val Markovic
fd0c2cc1d8 Updating to latest ycmd
This includes the using the new API for OmniCompleter.
2016-02-24 17:10:13 -08:00
Ben Jackson
e8de632b90 Add docs for RefactorRename
Additionally, we restructure subcommands section to organise by
command type.

There are now a significant number of subcommands offering quite
powerful features. A flat-list of such commands is not easy for users to
discover (citation needed). Restructured into:
 - GoTo commands
 - Documenation/type information commands
 - FixIt/refactor commands

This has the following benefits:
 - features are more discoverable to the user (due to contents page
   update)
 - more obvious where to add new subcommand documentation
 - a place to write notes which apply to multiple commands (such as
   jump lists, multi-file refactor)
2016-02-21 22:02:33 +00:00
micbou
60b101f3ba Add reference to ycmd in README 2016-02-17 20:15:36 +01:00
Spencer G. Jones
308cf4b653 Remove C# Diagnostic Support documentation note
This hasn't been true since ycmd pull request #44.
2016-02-16 19:27:26 -07:00
Homu
3e748deaec Auto merge of #1965 - micbou:go-documentation, r=puremourning
[READY] Update Go documentation with GoTo subcommands

This also updates to latest ycmd. Changes that affect the client:
 - update racerd;
 - add GoTo support for Go completer;
 - add concurrent requests for Typescript completer;
 - fix issue #1953;
 - add GoToReferences support for Typescript completer.

I changed the filetypes lists to be in alphabetical order, except the C-family languages.

<!-- Reviewable:start -->
[<img src="https://reviewable.io/review_button.svg" height="40" alt="Review on Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/1965)
<!-- Reviewable:end -->
2016-02-08 07:46:04 +09:00
micbou
716d0c974f Update Go documentation 2016-02-07 20:28:41 +01:00
Ilia Choly
ef47aba62a Update vimdoc 2016-02-06 16:24:47 -05:00
micbou
2cd3d1b9d3 Avoid confusion with make command 2016-02-03 17:51:35 +01:00
Andrea Cedraro
581f58add6 Update documentation of latest python completer 2016-02-03 00:12:00 +01:00
Chiel ten Brinke
833d30eda8 Update vim docs. 2016-01-29 10:40:34 +01:00
micbou
1805b88864 Update Windows generators in README 2016-01-11 13:05:55 +01:00
Joe Wilm
210db41a42 fixup! Update ycmd 2016-01-08 07:49:56 -08:00
Joe Wilm
0a4bd8ddf2 Fix Windows install.py invocations in README.md 2016-01-08 07:28:49 -08:00
Joe Wilm
a74a4cbd7a Add support for the Rust programming language 2016-01-07 08:52:15 -08:00
Ben Jackson
559c76232e update vimdoc 2015-12-24 11:49:58 +00:00
Ben Jackson
baba751dab Correct subcommand usage. Clarify changing project usage 2015-12-23 11:21:43 +00:00
Ben Jackson
0162d4ad71 Add a FAQ entry pointing at the instructions 2015-12-23 01:17:29 +00:00
Ben Jackson
ba700f2f0d Update Vim doc 2015-12-22 23:35:29 +00:00
Kenny Kaye
0c55527a38 Included usage example for error/warning getters 2015-12-05 11:06:33 -08:00
Kenny Kaye
908fd68548 Update help doc formatting 2015-12-05 10:34:05 -08:00
Kenny Kaye
bb8490e6c7 Properly namespace vim warning/error getters 2015-12-05 09:24:15 -08:00
Kenny Kaye
163238992c Document YcmGetErrorCount and YcmGetWarningCount functions 2015-12-05 09:12:28 -08:00
micbou
e95776890d Fix stdout and stderr occurences
Fix stdout and stderr occurences in documentation and contribution
guidelines.
2015-11-11 17:26:16 +01:00
micbou
b3c9f3ffc1 Add :YcmToggleLogs documentation 2015-11-08 18:43:52 +01:00
micbou
186aa6b671 Remove g:ycm_server_use_vim_stdout option
This option does not work like expected. Logs are not written to the
console. It also makes the ycmd server unresponsive on Windows.
2015-10-27 18:19:22 +01:00
micbou
de06e22a02 Update installation titles 2015-10-24 20:34:31 +02:00
micbou
2084ee2909 Add Fedora entry in README.md
Update Vim documentation
2015-10-23 15:08:48 +02:00
micbou
570444fc5a Add GoToInclude subcommand to documentation 2015-10-20 15:06:49 +02:00
micbou
2ace4eea88 Add Windows documentation 2015-10-11 15:22:04 +02:00
Ben Jackson
3ddc2fcbee Update documentation to add GetDoc subcommand 2015-09-24 22:25:27 +01:00
micbou
9750835cf0 Add AppVeyor configuration 2015-09-22 04:12:46 +02:00
Ben Jackson
449b6fbb9f Add super-quick feature summary by completer 2015-09-19 12:41:09 +01:00
Homu
e60fa3f138 Auto merge of #1679 - puremourning:typescript-subcommands, r=Valloric
Update subcommmands supported for typescript

Noticed that the subcommands supported by typescript are not listed. Updated the docs and ran

```
vim-tools/html2vimdoc.py -f youcompleteme README.md > doc/youcompleteme.txt
```
2015-09-15 13:03:30 +09:00
Spencer G. Jones
2a41101955 Merge remote-tracking branch 'origin/master' into CsAddImport 2015-09-13 08:49:28 -06:00
Ben Jackson
7c2b7b7ef3 Update subcommmands supported for typescript 2015-09-13 13:01:11 +01:00
Spencer G. Jones
df73ca6b66 Update g:ycm_csharp_insert_namespace_expr documention 2015-09-11 17:14:09 -06:00
Spencer G. Jones
391b3df3b7 Update mimimum version in documention 2015-09-10 10:12:59 -06:00
Spencer G. Jones
28e318c0bb fixup! To determine which completion prompted CompleteDone, look at the new variable if vim is recent enough. 2015-09-10 09:18:48 -06:00
micbou
9fc26130ef Update table of contents in README
Remove Project Management entry.
2015-09-02 01:54:05 +02:00
Spencer G. Jones
9f568be39a fixup! Add CompleteDone hook, with namespace insertion for C# 2015-08-31 10:51:23 -06:00
micbou
dab5ab1d72 Use SVG Travis badge 2015-08-28 00:44:51 +02:00
micbou
7d87bc3f82 Update documentation 2015-08-23 20:12:24 +02:00
Ben Jackson
c73b4aa529 Update vim help
Includes recent changes including FixIt and some other minor tweaks
2015-08-15 00:55:23 +01:00
Wladston Viana Ferreira Filho
0812cd815d Updating default semantic hooks.
The documentation was updated to be in sync with ycmd @bfcfa21,
regarding default semantic hooks defined in ycmd's completer_utils.py.
2015-07-22 23:21:36 -03:00
Strahinja Val Markovic
6ba88ccce5 Updating docs from README 2015-04-17 15:39:09 -07:00
Strahinja Val Markovic
a4a4f038d7 Updating vimdoc 2015-03-19 10:22:37 -07:00
Andrew Khosravian
7cf0bfc834 Fix up typo and phrasing in README & add g:ycm_csharp_server_port to youcompleteme.txt in doc 2015-01-27 14:36:27 -08:00
Strahinja Val Markovic
f33b7cae06 Updating vimdoc from README 2015-01-20 13:32:42 -08:00
Strahinja Val Markovic
319d384fc7 Updating vimdoc from README 2014-12-10 13:51:49 -08:00
Strahinja Val Markovic
f01b2121da Updating vimdoc from README 2014-09-07 20:37:47 -07:00
Val Markovic
61bc2c315d Merge pull request #1049 from dcohenp/doc-fix
Fix "GoToImplementation" command name in docs.
2014-07-16 09:57:56 -07:00
Alexandre Fonseca
e13cd9b696 Document '*' in ycm_filetype_specific_completion_to_disable. 2014-06-30 15:36:37 +02:00
Daniel Cohen
d4d2d2be35 Fix "GoToImplementation" command name in docs. 2014-06-24 00:22:26 -04:00
Adelar da Silva Queiróz
202d8ec36c Change reference of Bundle to Plugin in the docs 2014-06-05 00:20:27 -03:00
Adelar da Silva Queiróz
8672bacbea Change reference of Bundle to Plugin in the docs 2014-06-05 00:17:57 -03:00
Strahinja Val Markovic
72936e42f5 Updating vimdoc from readme
Fixes #1009
2014-06-03 17:20:59 -07:00
Strahinja Val Markovic
9d3258df19 Updating vimdoc from readme 2014-03-21 12:40:35 -07:00
Strahinja Val Markovic
8ceb453881 Updated vimdoc from readme 2014-01-29 11:03:19 -08:00
Strahinja Val Markovic
b1bba2e201 Changing copyright headers from me to Google
When I initially released this project, I released it under my own copyright. I
have since then worked on it in my 20% time at Google (and want to continue
doing this) and my life becomes much simpler if the copyright is Google's.

From the perspective of how this project is run and managed, **NOTHING**
changes. YCM is not a Google product, merely a project run by someone who just
happens to work for Google.

Please note that the license of the project is **NOT** changing.

People sending in future pull requests will have to sign the Google
[CLA](https://developers.google.com/open-source/cla/individual) (you can sign
online at the bottom of that page) before those pull requests could be merged
in. People who sent in pull requests that were merged in the past will get an
email from me asking them to sign the CLA as well.
2014-01-13 11:08:43 -08:00
Strahinja Val Markovic
0caf28de8f Updating vimdoc from README 2014-01-09 09:45:28 -08:00
Strahinja Val Markovic
f5b1fd9d77 Updating vimdoc from README 2013-12-10 11:19:53 -08:00
Strahinja Val Markovic
780d7b8dac Updating vimdoc from readme 2013-11-15 19:13:56 -08:00
Tom Vincent
650f014f16 Update filetype blacklist documentation
Follow existing `Default: '[see next line]'` style to avoid an overly long line
2013-10-30 02:12:51 +00:00
Strahinja Val Markovic
ed47a8c2a1 Updating vimdoc from readme 2013-10-26 16:29:12 -07:00
Strahinja Val Markovic
1aa3a12293 Updating vimdoc from README 2013-10-24 12:41:56 -07:00
Strahinja Val Markovic
591135cb91 Updating vimdoc from README 2013-08-12 20:58:21 -07:00
Strahinja Val Markovic
995bdf706f Update vimdoc from readme 2013-07-17 20:02:40 -07:00
Strahinja Val Markovic
872b4834c5 Updating vimdoc using new conversion script 2013-05-31 18:28:07 -07:00
Strahinja Val Markovic
a3f261764e Updating vimdoc 2013-05-28 19:02:04 -07:00
Strahinja Val Markovic
326fbccc55 Updating vimdoc 2013-05-27 11:03:39 -07:00
Strahinja Val Markovic
258f3dfd73 Updating vimdoc 2013-05-26 14:00:56 -07:00
Strahinja Val Markovic
ebfd9bfbb4 Updating vimdoc from README
Fixes #330
2013-05-20 18:18:01 -07:00
Strahinja Val Markovic
686f7951a7 Updating vimdoc from readme 2013-05-05 10:19:05 -07:00
Strahinja Val Markovic
7cef111e01 Updated vimdoc from readme 2013-04-30 10:18:15 -07:00
Strahinja Val Markovic
20c535a970 Updating vimdoc 2013-04-10 20:49:44 -07:00
Strahinja Val Markovic
bdb88f7b76 Updating vimdoc 2013-03-25 19:51:42 -07:00
Strahinja Val Markovic
8926a98bf4 Updating vimdoc from readme 2013-03-10 10:37:23 -07:00
Strahinja Val Markovic
6d64a841bb Updating vimdoc from readme 2013-03-01 18:40:02 -08:00
Val Markovic
9e3aa21a77 Merge pull request #119 from olajep/let-local-conf-override-global
Let local YCM config file override global config file
2013-02-17 13:07:38 -08:00
Ola Jeppsson
3d1a86c382 Let local YCM config file override global config file
Currently, when VIM opens a source file, YCM always defaults to
'g:global_ycm_extra_conf_file' if it exists.

This commit changes YCM's behaviour so that it first tries to find the config
file in the source file's folder (or any of its parents folder), before
falling back to 'g:global_ycm_extra_conf_file'.
2013-02-17 19:06:48 +01:00
Strahinja Val Markovic
c08210fd35 Vimdoc update, again 2013-02-16 14:29:50 -08:00
Strahinja Val Markovic
b0d7e38da7 Updating vimdoc 2013-02-16 14:21:18 -08:00
Strahinja Val Markovic
0399ec94c8 Updating vimdoc again 2013-02-12 20:59:11 -08:00
Strahinja Val Markovic
d9c5eead30 Updating the vimdoc file 2013-02-12 20:34:58 -08:00
Strahinja Val Markovic
57d5384dcc Updating vimdoc docs 2013-02-06 20:08:04 -08:00