mirror of
https://github.com/NotAShelf/neovim-flake.git
synced 2024-11-15 06:35:58 +01:00
docs: add mention of breaking changes at the start of the release notes
This commit is contained in:
parent
afdba509c4
commit
35d0c2983b
2 changed files with 11 additions and 1 deletions
|
@ -2,6 +2,16 @@
|
||||||
|
|
||||||
Release notes for release 0.7
|
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}
|
## Changelog {#sec-release-0.7-changelog}
|
||||||
|
|
||||||
[ItsSorae](https://github.com/ItsSorae):
|
[ItsSorae](https://github.com/ItsSorae):
|
||||||
|
|
|
@ -13,7 +13,7 @@
|
||||||
cfg = config.vim;
|
cfg = config.vim;
|
||||||
in {
|
in {
|
||||||
imports = [
|
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 = {
|
options.vim = {
|
||||||
|
|
Loading…
Reference in a new issue