2021-08-23 14:42:51 +00:00
|
|
|
Experimental features
|
|
|
|
=====================
|
|
|
|
|
|
|
|
Experimental or unstable features may be enabled by
|
|
|
|
|
|
|
|
./configure --enable-experimental
|
|
|
|
|
|
|
|
but as it says, the interface, command names, output formatting should be considered
|
|
|
|
unstable and not for production use. However testing is welcome and feedback or bugs
|
|
|
|
filed as issues.
|
|
|
|
|
|
|
|
In the code use it like:
|
|
|
|
|
2022-05-17 21:11:03 +00:00
|
|
|
.. code-block::
|
|
|
|
|
2021-08-23 14:42:51 +00:00
|
|
|
if (EXPERIMENTAL) {
|
|
|
|
...
|
|
|
|
}
|
|
|
|
|
2022-05-12 12:02:51 +00:00
|
|
|
in case it does not interfere with other code or does not depend on an `#if`
|
2021-08-23 14:42:51 +00:00
|
|
|
where it would break default build.
|
|
|
|
|
|
|
|
Or:
|
|
|
|
|
2022-05-17 21:11:03 +00:00
|
|
|
.. code-block::
|
|
|
|
|
2021-08-23 14:42:51 +00:00
|
|
|
#if EXPERIMENTAL
|
|
|
|
...
|
|
|
|
#endif
|
|
|
|
|
|
|
|
for larger code blocks.
|
|
|
|
|
2022-05-17 21:11:03 +00:00
|
|
|
.. note::
|
|
|
|
Do not use `#ifdef` as the macro is always defined so this would not work as
|
|
|
|
expected.
|
2022-05-12 12:02:51 +00:00
|
|
|
|
2022-05-17 21:11:03 +00:00
|
|
|
Each feature should be tracked in an issue with label **experimental** (list of
|
|
|
|
active issues https://github.com/kdave/btrfs-progs/labels/experimental), with a
|
|
|
|
description and a todo list items. Individual tasks can be tracked in other
|
2021-08-23 14:42:51 +00:00
|
|
|
issues if needed.
|