Skip to content

Commit f4acda0

Browse files
authored
Update vim docs
1 parent 0d387ad commit f4acda0

File tree

1 file changed

+3
-95
lines changed

1 file changed

+3
-95
lines changed

doc/youcompleteme.txt

Lines changed: 3 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,7 @@ Contents ~
2323
4. Windows |youcompleteme-windows|
2424
1. Quick start, installing all completers
2525
2. Explanation for the quick start
26-
5. FreeBSD/OpenBSD |youcompleteme-freebsd-openbsd|
27-
1. Quick start, installing all completers
28-
2. Explanation for the quick start
29-
6. Full Installation Guide |youcompleteme-full-installation-guide|
26+
5. Full Installation Guide |youcompleteme-full-installation-guide|
3027
4. Quick Feature Summary |youcompleteme-quick-feature-summary|
3128
1. General (all languages) |youcompleteme-general|
3229
2. C-family languages (C, C++, Objective C, Objective C++, CUDA) |youcompleteme-c-family-languages|
@@ -254,7 +251,6 @@ Contents ~
254251
- macOS
255252
- Linux 64-bit
256253
- Windows
257-
- FreeBSD/OpenBSD
258254
- Full Installation Guide
259255

260256
- Quick Feature Summary
@@ -850,94 +846,6 @@ YCM comes with sane defaults for its options, but you still may want to take a
850846
look at what's available for configuration. There are a few interesting options
851847
that are conservatively turned off by default that you may want to turn on.
852848

853-
-------------------------------------------------------------------------------
854-
*youcompleteme-freebsd-openbsd*
855-
FreeBSD/OpenBSD ~
856-
857-
-------------------------------------------------------------------------------
858-
Quick start, installing all completers ~
859-
860-
- Install YCM plugin via Vundle [26]
861-
- Install CMake
862-
>
863-
pkg install cmake
864-
<
865-
- Install xbuild, go, node and npm
866-
- Compile YCM
867-
>
868-
cd ~/.vim/bundle/YouCompleteMe
869-
python3 install.py --all
870-
<
871-
- For plugging an arbitrary LSP server, check the relevant section
872-
873-
-------------------------------------------------------------------------------
874-
Explanation for the quick start ~
875-
876-
These instructions (using 'install.py') are the quickest way to install
877-
YouCompleteMe, however they may not work for everyone. If the following
878-
instructions don't work for you, check out the full installation guide.
879-
880-
**NOTE:** OpenBSD / FreeBSD are not officially supported platforms by YCM.
881-
882-
Make sure you have a supported Vim version with Python 3 support, and a
883-
supported compiler and CMake, perhaps:
884-
>
885-
pkg install cmake
886-
<
887-
Install YouCompleteMe with Vundle [26].
888-
889-
**Remember:** YCM is a plugin with a compiled component. If you **update** YCM
890-
using Vundle and the 'ycm_core' library APIs have changed (happens rarely), YCM
891-
will notify you to recompile it. You should then rerun the install process.
892-
893-
Compiling YCM **with** semantic support for C-family languages through
894-
**clangd**:
895-
>
896-
cd ~/.vim/bundle/YouCompleteMe
897-
./install.py --clangd-completer
898-
<
899-
Compiling YCM **without** semantic support for C-family languages:
900-
>
901-
cd ~/.vim/bundle/YouCompleteMe
902-
./install.py
903-
<
904-
If the 'python' executable is not present, or the default 'python' is not the
905-
one that should be compiled against, specify the python interpreter explicitly:
906-
>
907-
python3 install.py --clangd-completer
908-
<
909-
The following additional language support options are available:
910-
911-
- C# support: install Mono and add '--cs-completer' when calling
912-
'./install.py'.
913-
914-
- Go support: install Go [31] and add '--go-completer' when calling
915-
'./install.py'.
916-
917-
- JavaScript and TypeScript support: install Node.js and npm [32] and add
918-
'--ts-completer' when calling 'install.py'.
919-
920-
- Rust support: add '--rust-completer' when calling './install.py'.
921-
922-
- Java support: install JDK 17 [33] and add '--java-completer' when calling
923-
'./install.py'.
924-
925-
To simply compile with everything enabled, there's a '--all' flag. So, to
926-
install with all language features, ensure 'xbuild', 'go', 'node' and 'npm'
927-
tools are installed and in your 'PATH', then simply run:
928-
>
929-
cd ~/.vim/bundle/YouCompleteMe
930-
./install.py --all
931-
<
932-
That's it. You're done. Refer to the _User Guide_ section on how to use YCM.
933-
Don't forget that if you want the C-family semantic completion engine to work,
934-
you will need to provide the compilation flags for your project to YCM. It's
935-
all in the User Guide.
936-
937-
YCM comes with sane defaults for its options, but you still may want to take a
938-
look at what's available for configuration. There are a few interesting options
939-
that are conservatively turned off by default that you may want to turn on.
940-
941849
-------------------------------------------------------------------------------
942850
*youcompleteme-full-installation-guide*
943851
Full Installation Guide ~
@@ -1399,7 +1307,7 @@ On supported architectures, the 'install.py' script will download a suitable
13991307
clangd ('--clangd-completer') or libclang ('--clang-completer') for you.
14001308
Supported architectures are:
14011309

1402-
- Linux glibc >= 2.27 (Intel, armv7-a, aarch64) - built on ubuntu 18.04
1310+
- Linux glibc >= 2.31 (Intel, armv7-a, aarch64) - built on ubuntu 20.04
14031311
- MacOS >=10.15 (Intel, arm64)
14041312
- For Intel, compatibility per clang.llvm.org downloads
14051313
- For arm64, macOS 10.15+
@@ -1423,7 +1331,7 @@ build or acquire 'libclang' for yourself and specify it when building, as:
14231331
$ EXTRA_CMAKE_ARGS='-DPATH_TO_LLVM_ROOT=/path/to/your/llvm' ./install.py --clang-completer --system-libclang
14241332
<
14251333
Please note that if using custom 'clangd' or 'libclang' it _must_ match the
1426-
version that YCM requires. Currently YCM requires **_clang 15.0.1_**.
1334+
version that YCM requires. Currently YCM requires **_clang 16.0.1_**.
14271335

14281336
-------------------------------------------------------------------------------
14291337
*youcompleteme-compile-flags*

0 commit comments

Comments
 (0)