From bc97e77ba7460ffef691cd2aae20aa067c125674 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Mon, 5 Oct 2026 10:39:03 +0200 Subject: [PATCH] man: reword "experimental" blurbs to be more accurate The text implied that the changes may happen randomly at any time. Obviously, they can only happen after an update, but also we're unlikely to do that not on a major release boundary. So town down that part of the message. At the same time, it's important that the change might just happen. For stable features, we also sometimes implement incompatible changes, but this is preceded by announcements and lengthy deprecation periods. So use the phrase "without advance notice". OTOH, the text implicitly promised future stabilization. This might or might not happen, so remind the users that it might not. (cherry picked from commit 96cb6a5c74c8cd64334c48ddcca18e128e9a40ea) --- man/experimental.xml | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/man/experimental.xml b/man/experimental.xml index 0c3db27971..ba9f55a3dd 100644 --- a/man/experimental.xml +++ b/man/experimental.xml @@ -8,16 +8,19 @@ - <!-- for individual section(s) of a manpage --> - <para id="option">This option is experimental and subject to change at any given moment without notice. - It will be stabilized and given a backward-compatibility guarantee in a future release.</para> + <!-- for individual sections of a manpage --> + <para id="option">This option is experimental and subject to change without advance notice. + It will be stabilized and given a backward-compatibility guarantee in a future release, + but may also possibly be removed.</para> - <para id="options">These options are experimental and subject to change at any given moment without notice. - They will be stabilized and given a backward-compatibility guarantee in a future release.</para> + <para id="options">These options are experimental and subject to change without advance notice. + They will be stabilized and given a backward-compatibility guarantee in a future release, + but may also possibly be removed.</para> <!-- for a whole manpage --> <refsect1 id="component"><title>Experimental - This component is experimental and subject to change at any given moment without notice. - It will be stabilized and given a backward-compatibility guarantee in a future release. + This component is experimental and subject to change without advance notice. + It will be stabilized and given a backward-compatibility guarantee in a future release, + but may also possibly be removed.