Permalink
Browse files

Auto merge of #2495 - puremourning:readme-compilation-database, r=micbou

[READY] Update readme for compilation database support

# 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.

> only changes docs

- [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

This change:
 - updates the c-family completer documentation to describe the built in support for compilation databases added in Valloric/ycmd#680
 - explains more about why ycmd needs compiler flags, and how to go about providing them
 - recommends using a compilation database (as that seems to be the fashion)
 - standardises formatting for `NOTE` (it was inconsistent before)
 - states that the preferred installation method is `install.py` (rather than the full installation instructions)
 - update the vim doc
 - update the ycmd submodule

### ycmd update release note

- Valloric/ycmd#678 - Bump Boost version to 1.63.0
- Valloric/ycmd#686 - Update JediHTTP for Python 3.6 support
- Valloric/ycmd#684 - Fix JavaScript identifier regex
- Valloric/ycmd#680 - Automatically load a compilation database if found

[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/2495)
<!-- Reviewable:end -->
  • Loading branch information...
2 parents f34b39d + 3eb8a33 commit d02de4b399eec80f28142ce39481be585ef3627f @homu homu committed Jan 8, 2017
Showing with 384 additions and 183 deletions.
  1. +166 −66 README.md
  2. +217 −116 doc/youcompleteme.txt
  3. +1 −1 third_party/ycmd
Oops, something went wrong.

0 comments on commit d02de4b

Please sign in to comment.