mirror of
https://github.com/rclone/rclone.git
synced 2024-12-16 12:11:31 +01:00
bff702a6f1
This adds an additional parameter to the creation of each flag. This specifies one or more flag groups. This **must** be set for global flags and **must not** be set for local flags. This causes flags.md to be built with sections to aid comprehension and it causes the documentation pages for each command (and the `--help`) to be built showing the flags groups as specified in the `groups` annotation on the command. See: https://forum.rclone.org/t/make-docs-for-mortals-not-only-rclone-gurus/39476/
58 lines
1.5 KiB
Go
58 lines
1.5 KiB
Go
// Package changenotify tests rclone's changenotify support
|
|
package changenotify
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"time"
|
|
|
|
"github.com/rclone/rclone/cmd"
|
|
"github.com/rclone/rclone/cmd/test"
|
|
"github.com/rclone/rclone/fs"
|
|
"github.com/rclone/rclone/fs/config/flags"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
pollInterval = 10 * time.Second
|
|
)
|
|
|
|
func init() {
|
|
test.Command.AddCommand(commandDefinition)
|
|
cmdFlags := commandDefinition.Flags()
|
|
flags.DurationVarP(cmdFlags, &pollInterval, "poll-interval", "", pollInterval, "Time to wait between polling for changes", "")
|
|
}
|
|
|
|
var commandDefinition = &cobra.Command{
|
|
Use: "changenotify remote:",
|
|
Short: `Log any change notify requests for the remote passed in.`,
|
|
Annotations: map[string]string{
|
|
"versionIntroduced": "v1.56",
|
|
},
|
|
RunE: func(command *cobra.Command, args []string) error {
|
|
cmd.CheckArgs(1, 1, command, args)
|
|
f := cmd.NewFsSrc(args)
|
|
ctx := context.Background()
|
|
|
|
// Start polling function
|
|
features := f.Features()
|
|
if do := features.ChangeNotify; do != nil {
|
|
pollChan := make(chan time.Duration)
|
|
do(ctx, changeNotify, pollChan)
|
|
pollChan <- pollInterval
|
|
fs.Logf(nil, "Waiting for changes, polling every %v", pollInterval)
|
|
} else {
|
|
return errors.New("poll-interval is not supported by this remote")
|
|
}
|
|
select {}
|
|
},
|
|
}
|
|
|
|
// changeNotify invalidates the directory cache for the relativePath
|
|
// passed in.
|
|
//
|
|
// if entryType is a directory it invalidates the parent of the directory too.
|
|
func changeNotify(relativePath string, entryType fs.EntryType) {
|
|
fs.Logf(nil, "%q: %v", relativePath, entryType)
|
|
}
|