neovim/BUILD.md at master

17 KiB

Raw Permalink Blame History

IMPORTANT: Before upgrading to a new version, always check for breaking changes.

Quick start

Install build prerequisites on your system
git clone https://github.com/neovim/neovim
cd neovim && make CMAKE_BUILD_TYPE=RelWithDebInfo
- If you want the stable release, also run git checkout stable.
- If you want to install to a custom location, set CMAKE_INSTALL_PREFIX. See also INSTALL.md.
- On BSD, use gmake instead of make.
- To build on Windows, see the Building on Windows section. MSVC (Visual Studio) is recommended.
sudo make install
- Default install location is /usr/local
- On Debian/Ubuntu, instead of installing files directly with sudo make install, you can run cd build && cpack -G DEB && sudo dpkg -i nvim-linux64.deb to build DEB-package and install it. This should help ensuring the clean removal of installed files.

Notes:

From the repository's root directory, running make will download and build all the needed dependencies and put the nvim executable in build/bin.
Third-party dependencies (libuv, LuaJIT, etc.) are downloaded automatically to .deps/. See the FAQ if you have issues.
After building, you can run the nvim executable without installing it by running VIMRUNTIME=runtime ./build/bin/nvim.
If you plan to develop Neovim, install Ninja for faster builds. It will automatically be used.
Install ccache for faster rebuilds of Neovim. It's used by default. To disable it, use CCACHE_DISABLE=true make.

Running tests

See test/README.md.

Building

First make sure you installed the build prerequisites. Now that you have the dependencies, you can try other build targets explained below.

The build type determines the level of used compiler optimizations and debug information:

Release: Full compiler optimizations and no debug information. Expect the best performance from this build type. Often used by package maintainers.
Debug: Full debug information; few optimizations. Use this for development to get meaningful output from debuggers like GDB or LLDB. This is the default if CMAKE_BUILD_TYPE is not specified.
RelWithDebInfo ("Release With Debug Info"): Enables many optimizations and adds enough debug info so that when Neovim ever crashes, you can still get a backtrace.

So, for a release build, just use:

make CMAKE_BUILD_TYPE=Release

(Do not add a -j flag if ninja is installed! The build will be in parallel automatically.)

Afterwards, the nvim executable can be found in build/bin. To verify the build type after compilation, run:

./build/bin/nvim --version | grep ^Build

To install the executable to a certain location, use:

make CMAKE_INSTALL_PREFIX=$HOME/local/nvim install

CMake, our main build system, caches a lot of things in build/CMakeCache.txt. If you ever want to change CMAKE_BUILD_TYPE or CMAKE_INSTALL_PREFIX, run rm -rf build first. This is also required when rebuilding after a Git commit adds or removes files (including from runtime) — when in doubt, run make distclean (which is basically a shortcut for rm -rf build .deps).

By default (USE_BUNDLED=1), Neovim downloads and statically links its needed dependencies. In order to be able to use a debugger on these libraries, you might want to compile them with debug information as well:

make distclean
make deps

Building on Windows

Windows / MSVC

MSVC (Visual Studio) is the recommended way to build on Windows. These steps were confirmed as of 2023.

Install Visual Studio (2017 or later) with the Desktop development with C++ workload.
- On 32-bit Windows, you will need this workaround.
Open the Neovim project folder.
- Visual Studio should detect the cmake files and automatically start building...
Choose the nvim.exe (bin\nvim.exe) target and hit F5.
- If the build fails, it may be because Visual Studio started the build with x64-{Debug,Release} before you switched the configuration to x86-Release.
  - Right-click CMakeLists.txt → Delete Cache.
  - Right-click CMakeLists.txt → Generate Cache.
- If you see an "access violation" from ntdll, you can ignore it and continue.
If you set an error like msgpackc.dll not found, try the nvim.exe (Install) target. Then switch back to nvim.exe (bin\nvim.exe).

Windows / MSVC PowerShell

To build from the command line (i.e. invoke the cmake commands yourself),

Ensure you have the Visual Studio environment variables, using any of the following:
- Using the Visual Studio Developer Command Prompt or Visual Studio Developer PowerShell
- Invoking Import-VisualStudioVars in PowerShell from this PowerShell module
- Invoking VsDevCmd.bat in Command Prompt
```
VsDevCmd.bat -arch=x64
```
This is to make sure that luarocks finds the Visual Studio installation, and doesn't fall back to MinGW with errors like:
```
'mingw32-gcc' is not recognized as an internal or external command
```

From the "Developer PowerShell" or "Developer Command Prompt":

cmake -S cmake.deps -B .deps -G Ninja -D CMAKE_BUILD_TYPE=Release
cmake --build .deps --config Release
cmake -B build -G Ninja -D CMAKE_BUILD_TYPE=Release
cmake --build build --config Release

Omit --config Release if you want a debug build.
Omit -G Ninja to use the "Visual Studio" generator.

Windows / CLion

Install CLion.
Open the Neovim project in CLion.
Select Build → Build All in 'Release'.

Windows / Cygwin

Install all dependencies the normal way, then build Neovim the normal way for a random CMake application (i.e. do not use the Makefile that automatically downloads and builds "bundled" dependencies).

The cygport repo contains Cygport files (e.g. APKBUILD, PKGBUILD) for all the dependencies not available in the Cygwin distribution, and describes any special commands or arguments needed to build. The Cygport definitions also try to describe the required dependencies for each one. Unless custom commands are provided, Cygport just calls autogen/cmake, make, make install, etc. in a clean and consistent way.

https://github.com/cascent/neovim-cygwin was built on Cygwin 2.9.0. Newer libuv should require slightly less patching. Some SSP stuff changed in Cygwin 2.10.0, so that might change things too when building Neovim.

Windows / MSYS2 / MinGW

From the MSYS2 shell, install these packages:

pacman -S \
    mingw-w64-x86_64-{gcc,cmake,make,ninja,diffutils}

From the Windows Command Prompt (cmd.exe), set up the PATH and build.
```
set PATH=c:\msys64\mingw64\bin;c:\msys64\usr\bin;%PATH%
```

You have two options:

Build using cmake and Ninja generator:

cmake -S cmake.deps -B .deps -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo
cmake --build .deps
cmake -B build -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo
cmake --build build

If you cannot install neovim with ninja install due to permission restriction, you can install neovim in a directory you have write access to.

cmake -S cmake.deps -B .deps -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo
cmake --build .deps
cmake -B build -G Ninja -D CMAKE_INSTALL_PREFIX=C:\nvim -D CMAKE_BUILD_TYPE=RelWithDebInfo
cmake --build build

Or, alternatively, you can use mingw32-make:

mingw32-make deps
mingw32-make CMAKE_BUILD_TYPE=RelWithDebInfo
:: Or you can do the previous command specifying a custom prefix
:: (Default is C:\Program Files (x86)\nvim)
:: mingw32-make CMAKE_BUILD_TYPE=RelWithDebInfo CMAKE_INSTALL_PREFIX=C:\nvim
mingw32-make install

Localization

Localization build

A normal build will create .mo files in build/src/nvim/po.

If you see msgfmt: command not found, you need to install gettext. On most systems, the package is just called gettext.

Localization check

To check the translations for $LANG, run make -C build check-po-$LANG. Examples:

cmake --build build --target check-po-de
cmake --build build --target check-po-pt_BR

check-po-$LANG generates a detailed report in ./build/src/nvim/po/check-${LANG}.log. (The report is generated by nvim, not by msgfmt.)

Localization update

To update the src/nvim/po/$LANG.po file with the latest strings, run the following:

cmake --build build --target update-po-$LANG

Note: Run src/nvim/po/cleanup.vim after updating.

Compiler options

To see the chain of includes, use the -H option (#918):

echo '#include "./src/nvim/buffer.h"' | \
> clang -I.deps/usr/include -Isrc -std=c99 -P -E -H - 2>&1 >/dev/null | \
> grep -v /usr/

grep -v /usr/ is used to filter out system header files.
-save-temps can be added as well to see expanded macros or commented assembly.

Custom Makefile

You can customize the build process locally by creating a local.mk, which is referenced at the top of the main Makefile. It's listed in .gitignore, so it can be used across branches. A new target in local.mk overrides the default make-target.

Here's a sample local.mk which adds a target to force a rebuild but does not override the default-target:

all:

rebuild:
	rm -rf build
	make

Third-party dependencies

Reference the Debian package (or alternatively, the Homebrew formula) for the precise list of dependencies/versions.

To build the bundled dependencies using CMake:

cmake -S cmake.deps -B .deps -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo
cmake --build .deps

By default the libraries and headers are placed in .deps/usr. Now you can build Neovim:

cmake -B build -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo
cmake --build build

How to build without "bundled" dependencies

Manually install the dependencies:
- libuv libluv libvterm luajit lua-lpeg lua-mpack msgpack-c tree-sitter tree-sitter-bash tree-sitter-c tree-sitter-lua tree-sitter-markdown tree-sitter-python tree-sitter-query tree-sitter-vim tree-sitter-vimdoc unibilium

Run CMake:

cmake -B build -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo
cmake --build build

If all the dependencies are not available in the package, you can use only some of the bundled dependencies as follows (example of using ninja):

cmake -S cmake.deps -B .deps -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo -DUSE_BUNDLED=OFF -DUSE_BUNDLED_LIBVTERM=ON -DUSE_BUNDLED_TS=ON
cmake --build .deps
cmake -B build -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo
cmake --build build

Run make, ninja, or whatever build tool you told CMake to generate.
- Using ninja is strongly recommended.
If treesitter parsers are not bundled, they need to be available in a parser/ runtime directory (e.g. /usr/share/nvim/runtime/parser/).

Debian 10 (Buster) example:

sudo apt install luajit libluajit-5.1-dev lua-mpack lua-lpeg libunibilium-dev libmsgpack-dev
cmake -S cmake.deps -B .deps -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo -DUSE_BUNDLED=OFF -DUSE_BUNDLED_LIBUV=ON -DUSE_BUNDLED_LUV=ON -DUSE_BUNDLED_LIBVTERM=ON -DUSE_BUNDLED_TS=ON
cmake --build .deps
cmake -B build -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo
cmake --build build

Example of using a Makefile

Example of using a package with all dependencies:
```
make USE_BUNDLED=OFF
```

Example of using a package with some dependencies:

make BUNDLED_CMAKE_FLAG="-DUSE_BUNDLED=OFF -DUSE_BUNDLED_LUV=ON -DUSE_BUNDLED_TS=ON -DUSE_BUNDLED_LIBVTERM=ON -DUSE_BUNDLED_LIBUV=ON"

Build prerequisites

General requirements (see #1469):

Clang or GCC version 4.9+
CMake version 3.13+, built with TLS/SSL support
- Optional: Get the latest CMake from an installer or the Python package (pip install cmake)

Platform-specific requirements are listed below.

Ubuntu / Debian

sudo apt-get install ninja-build gettext cmake unzip curl build-essential

RHEL / Fedora

sudo dnf -y install ninja-build cmake gcc make unzip gettext curl glibc-gconv-extra

openSUSE

sudo zypper install ninja cmake gcc-c++ gettext-tools curl

Arch Linux

sudo pacman -S base-devel cmake unzip ninja curl

Alpine Linux

apk add build-base cmake coreutils curl unzip gettext-tiny-dev

Void Linux

xbps-install base-devel cmake curl git

NixOS / Nix

Starting from NixOS 18.03, the Neovim binary resides in the neovim-unwrapped Nix package (the neovim package being just a wrapper to setup runtime options like Ruby/Python support):

cd path/to/neovim/src

Drop into nix-shell to pull in the Neovim dependencies:

nix-shell '<nixpkgs>' -A neovim-unwrapped

Configure and build:

rm -rf build && cmakeConfigurePhase
buildPhase

Tests are not available by default, because of some unfixed failures. You can enable them via adding this package in your overlay:

  neovim-dev = (super.pkgs.neovim-unwrapped.override  {
    doCheck=true;
  }).overrideAttrs(oa:{
    cmakeBuildType="debug";

    nativeBuildInputs = oa.nativeBuildInputs ++ [ self.pkgs.valgrind ];
    shellHook = ''
      export NVIM_PYTHON_LOG_LEVEL=DEBUG
      export NVIM_LOG_FILE=/tmp/log
      export VALGRIND_LOG="$PWD/valgrind.log"
    '';
  });

and replacing neovim-unwrapped with neovim-dev:

nix-shell '<nixpkgs>' -A neovim-dev

Neovim contains a Nix flake in the contrib folder, with 3 packages:

neovim to run the nightly
neovim-debug to run the package with debug symbols
neovim-developer to get all the tools to develop on neovim

Thus you can run Neovim nightly with nix run github:neovim/neovim?dir=contrib. Similarly to develop on Neovim: nix develop github:neovim/neovim?dir=contrib#neovim-developer.

FreeBSD

sudo pkg install cmake gmake sha unzip wget gettext curl

If you get an error regarding a sha256sum mismatch, where the actual SHA-256 hash is e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855, then this is your issue (that's the sha256sum of an empty file).

OpenBSD

doas pkg_add gmake cmake unzip curl gettext-tools

Build can sometimes fail when using the top level Makefile, apparently due to some third-party component (see #2445-comment). The following instructions use CMake:

mkdir .deps
cd .deps
cmake ../cmake.deps/
gmake
cd ..
mkdir build
cd build
cmake ..
gmake

macOS

macOS / Homebrew

Install Xcode Command Line Tools: xcode-select --install
Install Homebrew
Install Neovim build dependencies:
```
brew install ninja cmake gettext curl
```

Note: If you see Wget certificate errors (for older macOS versions less than 10.10):

brew install curl-ca-bundle
echo CA_CERTIFICATE=$(brew --prefix curl-ca-bundle)/share/ca-bundle.crt >> ~/.wgetrc

Note: If you see 'stdio.h' file not found, try the following:

open /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg

macOS / MacPorts

Install Xcode Command Line Tools: xcode-select --install
Install MacPorts
Install Neovim build dependencies:
```
sudo port install ninja cmake gettext
```