From 1868c77e16b233b87fbc02f3b6a42c6f1f094ba6 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Sun, 27 Oct 2019 10:32:56 +0000 Subject: [PATCH] rc: fix formatting of docs --- docs/content/rc.md | 10 +++++++++- fs/accounting/stats_groups.go | 4 +++- fs/config/rc.go | 1 + fs/rc/internal.go | 1 + fs/rc/jobs/job.go | 4 ++++ 5 files changed, 18 insertions(+), 2 deletions(-) diff --git a/docs/content/rc.md b/docs/content/rc.md index a11070798..5f6567956 100644 --- a/docs/content/rc.md +++ b/docs/content/rc.md @@ -340,6 +340,7 @@ Authentication is required for this call. ### config/get: Get a remote in the config file. {#config/get} Parameters: + - name - name of remote to get See the [config dump command](/commands/rclone_config_dump/) command for more information on the above. @@ -482,6 +483,7 @@ If group is not provided then summed up stats for all groups will be returned. Parameters + - group - name of the stats group (string) Returns the following values: @@ -523,8 +525,8 @@ This clears counters and errors for all stats or specific stats group if group is provided. Parameters + - group - name of the stats group (string) -``` ### core/transferred: Returns stats about completed transfers. {#core/transferred} @@ -538,6 +540,7 @@ returned. Note only the last 100 completed transfers are returned. Parameters + - group - name of the stats group (string) Returns the following values: @@ -561,6 +564,7 @@ Returns the following values: ### core/version: Shows the current version of rclone and the go runtime. {#core/version} This shows the current version of go and the go runtime + - version - rclone version, eg "v1.44" - decomposed - version number as [major, minor, patch, subpatch] - note patch and subpatch will be 999 for a git compiled version @@ -574,14 +578,17 @@ This shows the current version of go and the go runtime Parameters - None Results + - jobids - array of integer job ids ### job/status: Reads the status of the job ID {#job/status} Parameters + - jobid - id of the job (integer) Results + - finished - boolean - duration - time in seconds that the job ran for - endTime - time the job finished (eg "2018-10-26T18:50:20.528746884+01:00") @@ -596,6 +603,7 @@ Results ### job/stop: Stop the running job {#job/stop} Parameters + - jobid - id of the job (integer) ### operations/about: Return the space used on the remote {#operations/about} diff --git a/fs/accounting/stats_groups.go b/fs/accounting/stats_groups.go index dc77769ac..5cbdb682e 100644 --- a/fs/accounting/stats_groups.go +++ b/fs/accounting/stats_groups.go @@ -88,6 +88,7 @@ If group is not provided then summed up stats for all groups will be returned. Parameters + - group - name of the stats group (string) Returns the following values: @@ -140,6 +141,7 @@ returned. Note only the last 100 completed transfers are returned. Parameters + - group - name of the stats group (string) Returns the following values: @@ -192,8 +194,8 @@ This clears counters and errors for all stats or specific stats group if group is provided. Parameters + - group - name of the stats group (string) -` + "```" + ` `, }) } diff --git a/fs/config/rc.go b/fs/config/rc.go index b0ce34faf..fe0d27c9b 100644 --- a/fs/config/rc.go +++ b/fs/config/rc.go @@ -37,6 +37,7 @@ func init() { AuthRequired: true, Help: ` Parameters: + - name - name of remote to get See the [config dump command](/commands/rclone_config_dump/) command for more information on the above. diff --git a/fs/rc/internal.go b/fs/rc/internal.go index 31dc89ed8..e2562eb54 100644 --- a/fs/rc/internal.go +++ b/fs/rc/internal.go @@ -168,6 +168,7 @@ func init() { Title: "Shows the current version of rclone and the go runtime.", Help: ` This shows the current version of go and the go runtime + - version - rclone version, eg "v1.44" - decomposed - version number as [major, minor, patch, subpatch] - note patch and subpatch will be 999 for a git compiled version diff --git a/fs/rc/jobs/job.go b/fs/rc/jobs/job.go index 30c80cf91..5e5909fe6 100644 --- a/fs/rc/jobs/job.go +++ b/fs/rc/jobs/job.go @@ -237,9 +237,11 @@ func init() { Fn: rcJobStatus, Title: "Reads the status of the job ID", Help: `Parameters + - jobid - id of the job (integer) Results + - finished - boolean - duration - time in seconds that the job ran for - endTime - time the job finished (eg "2018-10-26T18:50:20.528746884+01:00") @@ -282,6 +284,7 @@ func init() { Help: `Parameters - None Results + - jobids - array of integer job ids `, }) @@ -300,6 +303,7 @@ func init() { Fn: rcJobStop, Title: "Stop the running job", Help: `Parameters + - jobid - id of the job (integer) `, })