From d8e07bfd8e9c011f73ef2066a546dfc0c1615616 Mon Sep 17 00:00:00 2001 From: nielash Date: Mon, 4 Dec 2023 07:37:05 -0500 Subject: [PATCH] bisync: document beta status more clearly - fixes #6082 --- cmd/bisync/cmd.go | 3 ++- cmd/bisync/help.go | 5 +++++ docs/content/bisync.md | 5 +++++ 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/cmd/bisync/cmd.go b/cmd/bisync/cmd.go index fafbfaff5..76768248e 100644 --- a/cmd/bisync/cmd.go +++ b/cmd/bisync/cmd.go @@ -138,6 +138,7 @@ var commandDefinition = &cobra.Command{ Annotations: map[string]string{ "versionIntroduced": "v1.58", "groups": "Filter,Copy,Important", + "status": "Beta", }, RunE: func(command *cobra.Command, args []string) error { cmd.CheckArgs(2, 2, command, args) @@ -163,7 +164,7 @@ var commandDefinition = &cobra.Command{ } } - fs.Logf(nil, "bisync is EXPERIMENTAL. Don't use in production!") + fs.Logf(nil, "bisync is IN BETA. Don't use in production!") cmd.Run(false, true, command, func() error { err := Bisync(ctx, fs1, fs2, &opt) if err == ErrBisyncAborted { diff --git a/cmd/bisync/help.go b/cmd/bisync/help.go index 61c944a59..68ad27570 100644 --- a/cmd/bisync/help.go +++ b/cmd/bisync/help.go @@ -56,5 +56,10 @@ On each successive run it will: Changes include |New|, |Newer|, |Older|, and |Deleted| files. - Propagate changes on Path1 to Path2, and vice-versa. +Bisync is **in beta** and is considered an **advanced command**, so use with care. +Make sure you have read and understood the entire [manual](https://rclone.org/bisync) +(especially the [Limitations](https://rclone.org/bisync/#limitations) section) before using, +or data loss can result. Questions can be asked in the [Rclone Forum](https://forum.rclone.org/). + See [full bisync description](https://rclone.org/bisync/) for details. `) diff --git a/docs/content/bisync.md b/docs/content/bisync.md index 30d45b884..6d8e5cd1b 100644 --- a/docs/content/bisync.md +++ b/docs/content/bisync.md @@ -2,8 +2,13 @@ title: "Bisync" description: "Bidirectional cloud sync solution in rclone" versionIntroduced: "v1.58" +status: Beta --- +## Bisync +`bisync` is **in beta** and is considered an **advanced command**, so use with care. +Make sure you have read and understood the entire [manual](https://rclone.org/bisync) (especially the [Limitations](#limitations) section) before using, or data loss can result. Questions can be asked in the [Rclone Forum](https://forum.rclone.org/). + ## Getting started {#getting-started} - [Install rclone](/install/) and setup your remotes.