From 5b8a339baf32f2c064559dfea968a67e87baa8cc Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Mon, 23 Sep 2019 12:55:28 +0100 Subject: [PATCH] docs: Add notes on how to find out the encodings used in a backend --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7c9ecd9e..c62f13b12 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -341,6 +341,12 @@ Getting going * Add your remote to the imports in `backend/all/all.go` * HTTP based remotes are easiest to maintain if they use rclone's rest module, but if there is a really good go SDK then use that instead. * Try to implement as many optional methods as possible as it makes the remote more usable. + * Use fs/encoder to make sure we can encode any path name and `rclone info` to help determine the encodings needed + * `go install -tags noencode` + * `rclone purge -v TestRemote:rclone-info` + * `rclone info -vv --write-json remote.json TestRemote:rclone-info` + * `go run cmd/info/internal/build_csv/main.go -o remote.csv remote.json` + * open `remote.csv` in a spreadsheet and examine Unit tests