From 35d0c2983b6e3d13ad6f462a9db53f9ae18485e6 Mon Sep 17 00:00:00 2001 From: diniamo Date: Tue, 16 Jul 2024 19:05:10 +0200 Subject: [PATCH] docs: add mention of breaking changes at the start of the release notes --- docs/release-notes/rl-0.7.md | 10 ++++++++++ modules/wrapper/rc/options.nix | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/rl-0.7.md b/docs/release-notes/rl-0.7.md index 61fbf7b..712a376 100644 --- a/docs/release-notes/rl-0.7.md +++ b/docs/release-notes/rl-0.7.md @@ -2,6 +2,16 @@ Release notes for release 0.7 +## Breaking Changes and Migration Guide {#sec-breaking-changes-and-migration-guide-0-7} + +In v0.7 we are removing `vim.configRC` in favor of making `vim.luaConfigRC` the top-level DAG, and thereby making the entire configuration lua based. + +_Why?_ because Neovim is supposed to be mainly lua based. Also, vimscript is slow. + +This comes with a few breaking changes: +- `vim.configRC` has been removed, which means that you have to convert all of your custom vimscript-based configuration to lua. As for how to do that, you will have to consult the Neovim documentation and your search engine. +- After doing that, you might not be able to use the same entry names in `vim.luaConfigRC`, because those have also slightly changed. See the new [DAG entries in nvf](/index.xhtml#ch-dag-entries) manual page for more details. + ## Changelog {#sec-release-0.7-changelog} [ItsSorae](https://github.com/ItsSorae): diff --git a/modules/wrapper/rc/options.nix b/modules/wrapper/rc/options.nix index 0c551c8..14c7e8a 100644 --- a/modules/wrapper/rc/options.nix +++ b/modules/wrapper/rc/options.nix @@ -13,7 +13,7 @@ cfg = config.vim; in { imports = [ - (mkRemovedOptionModule ["vim" "configRC"] "Migrate your configRC sections to lua, and add them to luaConfigRC instead.") + (mkRemovedOptionModule ["vim" "configRC"] "Migrate your configRC sections to lua, and add them to luaConfigRC instead. See the v0.7 release notes for more information.") ]; options.vim = {