add feature flag documentation

This commit is contained in:
Michael Eischer
2024-03-09 17:29:52 +01:00
parent 70839155f2
commit fe68d2cafb
3 changed files with 45 additions and 3 deletions
+9 -2
View File
@@ -10,14 +10,21 @@ import (
"github.com/spf13/cobra"
)
// FIXME explain semantics
var featuresCmd = &cobra.Command{
Use: "features",
Short: "Print list of feature flags",
Long: `
The "features" command prints a list of supported feature flags.
To pass feature flags to restic, set the RESTIC_FEATURES environment variable
to "featureA=true,featureB=false". Specifying an unknown feature flag is an error.
A feature can either be in alpha, beta, stable or deprecated state.
An _alpha_ feature is disabled by default and may change in arbitrary ways between restic versions or be removed.
A _beta_ feature is enabled by default, but still can change in minor ways or be removed.
A _stable_ feature is always enabled and cannot be disabled. The flag will be removed in a future restic version.
A _deprecated_ feature is always disabled and cannot be enabled. The flag will be removed in a future restic version.
EXIT STATUS
===========