RepoMirrors/btrfs-progs
1
0
Fork 0
mirror of https://github.com/kdave/btrfs-progs synced 2025-01-19 04:00:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
683f41bfb0
btrfs-progs/Documentation/Experimental.md
David Sterba 6ea4830f8f btrfs-progs: build: add configure time option to enable experimental features 
Add --enable-experimental configure option that allows to merge unstable
features or partially implemented features. This is supposed to help
features that need time to settle, tweak output or formatting and would
require constant rebases and would have limited exposure to users that
could provide feedback.

If this is enabled, the following may change without notice:

- the whole feature may disappear in the future
- new command names could change or relocate to other subcommands
- parameter names
- output formatting
- json output

Signed-off-by: David Sterba <dsterba@suse.com>
2021-08-25 15:38:53 +02:00

811 B
Raw Blame History

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:

if (EXPERIMENTAL) {
    ...
}

in case it does not interfere with other code or does not depend on an #ifdef where it would break default build.

Or:

#if EXPERIMENTAL
...
#endif

for larger code blocks.

Each feature should be tracked in an issue with label experimental, with a description and a todo list items. Individual tasks can be tracked in other issues if needed.