Nick Craig-Wood
bff702a6f1
docs: group the global flags and make them appear on command and flags pages
...
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/
2023-08-02 12:53:09 +01:00
albertony
313493d51b
docs: remove minimum versions from command pages of pre v1 commands
2022-12-03 18:58:55 +01:00
albertony
6d18f60725
docs: add minimum versions to the command pages
2022-12-03 18:58:55 +01:00
Josh Soref
ce3b65e6dc
all: fix spelling across the project
...
* abcdefghijklmnopqrstuvwxyz
* accounting
* additional
* allowed
* almost
* already
* appropriately
* arise
* bandwidth
* behave
* bidirectional
* brackets
* cached
* characters
* cloud
* committing
* concatenating
* configured
* constructs
* current
* cutoff
* deferred
* different
* directory
* disposition
* dropbox
* either way
* error
* excess
* experiments
* explicitly
* externally
* files
* github
* gzipped
* hierarchies
* huffman
* hyphen
* implicitly
* independent
* insensitive
* integrity
* libraries
* literally
* metadata
* mimics
* missing
* modification
* multipart
* multiple
* nightmare
* nonexistent
* number
* obscure
* ourselves
* overridden
* potatoes
* preexisting
* priority
* received
* remote
* replacement
* represents
* reproducibility
* response
* satisfies
* sensitive
* separately
* separator
* specifying
* string
* successful
* synchronization
* syncing
* šenfeld
* take
* temporarily
* testcontents
* that
* the
* themselves
* throttling
* timeout
* transaction
* transferred
* unnecessary
* using
* webbrowser
* which
* with
* workspace
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2022-08-30 11:16:26 +02:00
albertony
555def2da7
build: add package comments to silence revive linter
2022-08-28 13:43:51 +02:00
Atílio Antônio
c08d48a50d
docs: improve grammar and fix typos ( #5361 )
...
This alters some comments in source files, but is interested mainly in documentation files and help messages.
2021-11-04 12:50:43 +01:00
Martin Michlmayr
cd075f1703
docs: fix markup of arguments #4276
...
Command line arguments have to be marked as code.
2021-01-25 22:40:46 +03:00
Josh Soref
8bc9b2b883
docs: grammar: examples are examples
...
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-28 18:16:23 +00:00
Josh Soref
e4a87f772f
docs: spelling: e.g.
...
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-10-28 18:16:23 +00:00
Nick Craig-Wood
19429083ad
cmd: fix spelling of Definition
2019-10-14 17:02:09 +01:00
Nick Craig-Wood
57d5de6fba
build: fix up package paths after repo move
...
git grep -l github.com/ncw/rclone | xargs -d'\n' perl -i~ -lpe 's|github.com/ncw/rclone|github.com/rclone/rclone|g'
goimports -w `find . -name \*.go`
2019-07-28 18:47:38 +01:00
Aleksandar Jankovic
f78cd1e043
Add context propagation to rclone
...
- Change rclone/fs interfaces to accept context.Context
- Update interface implementations to use context.Context
- Change top level usage to propagate context to lover level functions
Context propagation is needed for stopping transfers and passing other
request-scoped values.
2019-06-19 11:59:46 +01:00
Fabian Möller
48c09608ea
fix spelling
2019-04-30 14:12:18 +02:00
Nick Craig-Wood
96a62d55a2
lsd: Add -R flag and fix and update docs for all ls commands
2018-04-26 08:55:03 +01:00
Nick Craig-Wood
9fbc40c5b9
fstests: List missing dir must return ErrorDirNotFound for non bucket based remotes
...
List or ListR of an non existent directory must return
ErrorDirNotFound for non bucket based remotes. For bucket based
remotes it may return ErrorDirNotFound or it may return no error and
no entries.
2018-04-20 23:22:46 +01:00
Nick Craig-Wood
11da2a6c9b
Break the fs package up into smaller parts.
...
The purpose of this is to make it easier to maintain and eventually to
allow the rclone backends to be re-used in other projects without
having to use the rclone configuration system.
The new code layout is documented in CONTRIBUTING.
2018-01-15 17:51:14 +00:00
Nick Craig-Wood
ed20fa5ee7
ls* commands: update docs and add defaults into options for lsf
2018-01-06 17:00:20 +00:00
Lukas Loesche
5894c02a34
Typo: the the -> the in docs and comments
2017-01-03 20:48:26 +00:00
Nick Craig-Wood
2cbdb95ce5
Only show transfer stats on commands which transfer stuff - fixes #849
2016-12-04 16:52:24 +00:00
Nick Craig-Wood
5e35aeca9e
Regularize the command definition names
2016-12-03 09:08:40 +00:00
Nick Craig-Wood
e27b91ffb8
Factor each commmand into its own package
2016-08-05 17:13:54 +01:00
