1
mirror of https://github.com/rclone/rclone synced 2024-11-26 04:07:22 +01:00

bisync: document beta status more clearly - fixes #6082

This commit is contained in:
nielash 2023-12-04 07:37:05 -05:00
parent 199d82969b
commit d8e07bfd8e
3 changed files with 12 additions and 1 deletions

View File

@ -138,6 +138,7 @@ var commandDefinition = &cobra.Command{
Annotations: map[string]string{ Annotations: map[string]string{
"versionIntroduced": "v1.58", "versionIntroduced": "v1.58",
"groups": "Filter,Copy,Important", "groups": "Filter,Copy,Important",
"status": "Beta",
}, },
RunE: func(command *cobra.Command, args []string) error { RunE: func(command *cobra.Command, args []string) error {
cmd.CheckArgs(2, 2, command, args) 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 { cmd.Run(false, true, command, func() error {
err := Bisync(ctx, fs1, fs2, &opt) err := Bisync(ctx, fs1, fs2, &opt)
if err == ErrBisyncAborted { if err == ErrBisyncAborted {

View File

@ -56,5 +56,10 @@ On each successive run it will:
Changes include |New|, |Newer|, |Older|, and |Deleted| files. Changes include |New|, |Newer|, |Older|, and |Deleted| files.
- Propagate changes on Path1 to Path2, and vice-versa. - 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. See [full bisync description](https://rclone.org/bisync/) for details.
`) `)

View File

@ -2,8 +2,13 @@
title: "Bisync" title: "Bisync"
description: "Bidirectional cloud sync solution in rclone" description: "Bidirectional cloud sync solution in rclone"
versionIntroduced: "v1.58" 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} ## Getting started {#getting-started}
- [Install rclone](/install/) and setup your remotes. - [Install rclone](/install/) and setup your remotes.