mirror of https://github.com/rclone/rclone synced 2024-11-28 06:41:41 +01:00

Go to file

edwardxml 127f48e8ad docs: Rewrite rclone filtering documentation This is an attempt at rewriting the rclone filter documentation page. I have drawn largely from what appears to be the strong original structure of the page; existing text, and forum comments. The term flag is used throughout rather than differentiating `--` options with more complex arguments. That diverges from some standard practice but is consistent with messages in the rclone binary and `go` documentation. The term directory not folder is used throughout. I tried referring to objects more broadly rather than files and it just did not seem to work. Apart from a note at the top the explanations refer entirely to paths, directories and files. My justification is that bucket store users understand the concept of files. Not all users of directory aware storage are so familiar with objects, keys and metadata. Many of the changes I have made involve moving issues into what seemed to me to be more relevant parts of the original page structure. I still find the content repetitious and overly long but that may be inevitable when users can only be expected to read the section of the page they think most relevant. I have eliminated the rsync section from the original structure. It is hard enough explaining how rclone filters work without also setting out how they do not. Comment on sync is instead relegated to a paragraph in the directory filter section. The structure of the page is intended to work with a hugo toc card from html Header2 to Header3. My original intention was to establish a separate examples section. I have instead retained examples in each section, added to them and tried to make clear what is documentation and what example. The changes draw on Github and Forum issues too numerous to mention. for instance: https://forum.rclone.org/t/certain-exclusion-flags-seem-to-be-ignored/20049/2 I am especially grateful for https://forum.rclone.org/t/object-key-remote-directory-filter-clarification/20386/2 for making sense of directory filters for me. @ncw has a fun (and useful) online filter app at https://filterdemo.rclone.org/ I have not referred to it at this stage though I particularly like the fact that it is tied to the same codebase as an rclone version. I have added cautions about mixing the `--filter...` flags with `--exclude...` or `--include...`. The same issues seem to arise as already recognised between the latter two. The formal summary of glob syntax introduced at the top of the page is shamelessly stolen from https://godoc.org/github.com/gobwas/glob I have tried not to alter too many header descriptions and thereby break existing links to them. The reference to 'lass' in the example has been retained to confuse all those not of Scottish or Yorkshire heritage. Some of my activity was to remove ambiguity and I anticipate suggestions to roll that back where it has become overly complex. I tried particularly to bring together and make clear material about directory filters. It was previously scattered throughout the page and I couldn't understand it. I am particularly grateful for the explanations I received about directory filters though any remaining errors are entirely my own. Removed erroneous references to non existent `--filter...` flags. In some ways the best person to write this page would be one with no knowledge whatsoever of how rclone filters work. The further I got into it the better qualified I found myself to be. E&OE		2021-01-22 16:59:22 +00:00
.github	build: add go1.16beta1 to the build matrix	2021-01-08 12:22:37 +00:00
backend	qingstor: fix rclone cleanup	2021-01-21 17:35:31 +00:00
bin	build: add -buildmode to cross-compile.go	2021-01-08 08:58:50 +00:00
cmd	dedup: add warning if used on a remote which can't have duplicate names	2021-01-22 15:25:35 +00:00
contrib/docker	Contrib: Add sample WebDAV server Docker Compose manifest.	2019-09-15 16:06:54 +01:00
docs	docs: Rewrite rclone filtering documentation	2021-01-22 16:59:22 +00:00
fs	rc/jobs: add listener for finished jobs	2021-01-21 13:43:41 +00:00
fstest	compress: improve testing	2021-01-18 21:42:58 +01:00
graphics	build: Add file properties and icon to Windows executable (fixes #4304 )	2020-06-11 09:26:14 +01:00
lib	mount: more user friendly mounting as network drive on windows	2020-12-28 13:59:34 +00:00
vfs	vfs: fix file leaks with --vfs-cache-mode full and --buffer-size 0	2021-01-21 18:35:04 +00:00
.gitattributes	build: add azure pipelines build	2019-08-06 10:31:32 +01:00
.gitignore	lib: Add file name compression	2020-08-13 16:14:11 +01:00
.golangci.yml	build: move linter build tags into Makefile to fix golangci-lint	2019-04-12 15:48:36 +01:00
CONTRIBUTING.md	docs: spelling: etc.	2020-10-28 18:16:23 +00:00
COPYING	Initial commit - some small parts working	2012-11-18 17:32:31 +00:00
Dockerfile	build: fix custom timezone in Docker image	2020-06-17 10:43:03 +01:00
go.mod	HDFS (Hadoop Distributed File System) implementation - #42	2021-01-07 09:48:51 +00:00
go.sum	HDFS (Hadoop Distributed File System) implementation - #42	2021-01-07 09:48:51 +00:00
MAINTAINERS.md	compress: finish docs	2020-12-02 16:30:02 +01:00
Makefile	build: add -buildmode to cross-compile.go	2021-01-08 08:58:50 +00:00
MANUAL.html	docs: fix a typo in the dedupe docs	2021-01-05 15:46:57 +00:00
MANUAL.md	docs: fix small spelling nit, file -> find in FAQ	2021-01-13 17:36:57 +00:00
MANUAL.txt	docs: fix a typo in the dedupe docs	2021-01-05 15:46:57 +00:00
notes.txt	docs: spelling: etc.	2020-10-28 18:16:23 +00:00
rclone.1	Version v1.53.0	2020-09-02 17:00:18 +01:00
rclone.go	lib: add plugin support	2019-09-29 11:05:10 +01:00
README.md	HDFS (Hadoop Distributed File System) implementation - #42	2021-01-07 09:48:51 +00:00
RELEASE.md	build: Stop tagged releases making a current beta - fixes #4789	2020-11-25 09:48:29 +00:00
VERSION	Start v1.54.0-DEV development	2020-09-02 17:52:58 +01:00