mirror of
https://github.com/kdave/btrfs-progs
synced 2025-02-02 10:51:43 +00:00
6ea4830f8f
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>
33 lines
811 B
Markdown
33 lines
811 B
Markdown
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](https://github.com/kdave/btrfs-progs/labels/experimental), with
|
|
a description and a todo list items. Individual tasks can be tracked in other
|
|
issues if needed.
|