diff options
| author | dundargoc <33953936+dundargoc@users.noreply.github.com> | 2022-10-17 00:31:51 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-16 15:31:51 -0700 |
| commit | 8617101b6bf21bf27ba5194db5fb42c73ff67160 (patch) | |
| tree | cd842b437bdfff34605a63783846fadf753ecbf1 | |
| parent | 8f31a730c0dd76180648ba3b7c94aa5d059432e5 (diff) | |
| download | rneovim-8617101b6bf21bf27ba5194db5fb42c73ff67160.tar.gz rneovim-8617101b6bf21bf27ba5194db5fb42c73ff67160.tar.bz2 rneovim-8617101b6bf21bf27ba5194db5fb42c73ff67160.zip | |
docs: "supported platforms" matrix #19615
Inspired by libuv's own SUPPORTED_PLATFORMS.md:
https://github.com/libuv/libuv/blob/v1.x/
https://neovim.io/doc/user/support.html
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | runtime/doc/help.txt | 2 | ||||
| -rw-r--r-- | runtime/doc/support.txt | 52 |
3 files changed, 55 insertions, 1 deletions
@@ -53,7 +53,7 @@ Pre-built packages for Windows, macOS, and Linux are found on the Install from source ------------------- -See the [Building Neovim](https://github.com/neovim/neovim/wiki/Building-Neovim) wiki page for details. +See the [Building Neovim](https://github.com/neovim/neovim/wiki/Building-Neovim) wiki page and [supported platforms](https://neovim.io/doc/user/support.html#supported-platforms) for details. The build is CMake-based, but a Makefile is provided as a convenience. After installing the dependencies, run the following command. diff --git a/runtime/doc/help.txt b/runtime/doc/help.txt index 21bee24171..88b1aa4055 100644 --- a/runtime/doc/help.txt +++ b/runtime/doc/help.txt @@ -179,6 +179,7 @@ Versions ~ |deprecated.txt| Deprecated items that have been or will be removed Other ~ +|news.txt| News and notable changes in the latest release |terminal_emulator.txt| Terminal buffers |term.txt| Terminal UI |ui.txt| Nvim UI protocol @@ -187,6 +188,7 @@ Other ~ |job_control.txt| Spawn and control multiple processes |luaref.txt| Lua reference manual |luvref.txt| Luv (|vim.loop|) reference manual +|support.txt| Supported platforms *standard-plugin-list* Standard plugins ~ diff --git a/runtime/doc/support.txt b/runtime/doc/support.txt new file mode 100644 index 0000000000..82e20c7b9f --- /dev/null +++ b/runtime/doc/support.txt @@ -0,0 +1,52 @@ +*support.txt* Nvim + + + NVIM REFERENCE MANUAL + + +Support + + Type |gO| to see the table of contents. + +============================================================================== +Supported platforms *supported-platforms* + +`System` `Tier` `Versions` `Tested versions` +Linux 1 >= 2.6.32, glibc >= 2.12 Ubuntu 20.04 +macOS (Intel) 1 >= 10.15 macOS 11 +Windows 64-bit 1 >= 8 Windows Server 2019 +FreeBSD 1 >= 10 FreeBSD 13 +macOS (M1) 2 >= 10.15 +OpenBSD 2 >= 7 +MinGW 2 MinGW-w64 + +Support types ~ + +* Tier 1: Officially supported and tested with CI. Any contributed patch + MUST NOT break such systems. + +* Tier 2: Officially supported, but not necessarily tested with CI. These + systems are maintained to the best of our ability, without being a top + priority. + +* Tier 3: Not tested and no guarantees, but may work. + +Adding support for a new platform ~ + +IMPORTANT: Before attempting to add support for a new platform please open +an issue about it for discussion. + + +============================================================================== +Common + +Some common notes when adding support for new platforms: + +Cmake is the only supported build system. The platform must be buildable with cmake. + +All functionality related to the new platform must be implemented in its own +file inside `src/nvim/os` unless it's already done in a common file, in which +case adding an `#ifdef` is fine. + + + vim:tw=78:ts=8:et:ft=help:norl: |