Skip to content

Commit 6d8307f

Browse files
committed
runtime(doc): Add a Development policy
closes: #18197 Signed-off-by: Christian Brabandt <cb@256bit.org>
1 parent b2e21cc commit 6d8307f

3 files changed

Lines changed: 37 additions & 2 deletions

File tree

runtime/doc/develop.txt

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*develop.txt* For Vim version 9.1. Last change: 2025 Sep 01
1+
*develop.txt* For Vim version 9.1. Last change: 2025 Sep 04
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -13,6 +13,7 @@ Vim.
1313
2. Design decisions |design-decisions|
1414
3. Assumptions |design-assumptions|
1515
4. Coding style |coding-style|
16+
5. Policy |design-policy|
1617

1718
See the file README.txt in the "src" directory for an overview of the source
1819
code.
@@ -728,4 +729,35 @@ OK: do
728729
while (cond);
729730

730731

732+
==============================================================================
733+
5. Policy *design-policy* *new-features* *deprecated-features*
734+
735+
The time between either a new minor (e.g. 9.2.0) or major (e.g. 10.0) version
736+
is released is called a development cycle. Within the development cycle each
737+
single change to the C core will receive a new increased human-readable patch
738+
number in order to reference each specific patch release. A typical
739+
development release cycle may last several years and accumulate about 1500 -
740+
2500 patch numbers.
741+
742+
Before a release is made, a stability period will be announced. During this
743+
time, only clear bug fixes, security fixes, documentation changes, translation
744+
updates and runtime file updates will be accepted (provided they do not
745+
introduce backwards-incompatible changes), concentrating on polishing up the
746+
upcoming release.
747+
748+
New features are accepted only within a development cycle, but not within the
749+
stability period. During the cycle, new features may be developed and are
750+
allowed to change, but they must be settled before the cycle closes.
751+
752+
Once a minor release has been made, features included in that release must not
753+
receive any backwards-incompatible changes. Later patches are expected to
754+
preserve compatibility for the C core of Vim. Runtime files are handled a bit
755+
more flexibly to give runtime files maintainers a chance to change old
756+
behaviour.
757+
758+
Within a development cycle, features may be marked as deprecated. Deprecated
759+
features can be disabled at compile time through an appropriate switch. After
760+
a new release, deprecated features may be removed completely in a following
761+
cycle.
762+
731763
vim:tw=78:ts=8:noet:ft=help:norl:

runtime/doc/tags

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6969,6 +6969,7 @@ delete-menus gui.txt /*delete-menus*
69696969
deletebufline() builtin.txt /*deletebufline()*
69706970
deleting change.txt /*deleting*
69716971
demoserver.py channel.txt /*demoserver.py*
6972+
deprecated-features develop.txt /*deprecated-features*
69726973
design-assumptions develop.txt /*design-assumptions*
69736974
design-compatible develop.txt /*design-compatible*
69746975
design-decisions develop.txt /*design-decisions*
@@ -6979,6 +6980,7 @@ design-improved develop.txt /*design-improved*
69796980
design-maintain develop.txt /*design-maintain*
69806981
design-multi-platform develop.txt /*design-multi-platform*
69816982
design-not develop.txt /*design-not*
6983+
design-policy develop.txt /*design-policy*
69826984
design-speed-size develop.txt /*design-speed-size*
69836985
desktop.vim syntax.txt /*desktop.vim*
69846986
develop-spell develop.txt /*develop-spell*
@@ -9367,6 +9369,7 @@ new-diff-mode version6.txt /*new-diff-mode*
93679369
new-encryption version5.txt /*new-encryption*
93689370
new-evim version6.txt /*new-evim*
93699371
new-ex-commands-5.2 version5.txt /*new-ex-commands-5.2*
9372+
new-features develop.txt /*new-features*
93709373
new-file-browser version6.txt /*new-file-browser*
93719374
new-file-writing version6.txt /*new-file-writing*
93729375
new-filetype filetype.txt /*new-filetype*

runtime/doc/vi_diff.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*vi_diff.txt* For Vim version 9.1. Last change: 2025 Sep 02
1+
*vi_diff.txt* For Vim version 9.1. Last change: 2025 Sep 04
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar

0 commit comments

Comments
 (0)