mirror of
https://github.com/rclone/rclone.git
synced 2024-11-26 02:09:55 +08:00
docs: don't show fictional example values for options as multiple choice items
See #5538
This commit is contained in:
parent
8efead1ee6
commit
f589dbc077
|
@ -48,12 +48,8 @@ func init() {
|
||||||
NewFs: NewFs,
|
NewFs: NewFs,
|
||||||
Options: []fs.Option{{
|
Options: []fs.Option{{
|
||||||
Name: "host",
|
Name: "host",
|
||||||
Help: "FTP host to connect to.",
|
Help: "FTP host to connect to.\n\nE.g. \"ftp.example.com\".",
|
||||||
Required: true,
|
Required: true,
|
||||||
Examples: []fs.OptionExample{{
|
|
||||||
Value: "ftp.example.com",
|
|
||||||
Help: "Connect to ftp.example.com",
|
|
||||||
}},
|
|
||||||
}, {
|
}, {
|
||||||
Name: "user",
|
Name: "user",
|
||||||
Help: "FTP username, leave blank for current username, " + currentUser + ".",
|
Help: "FTP username, leave blank for current username, " + currentUser + ".",
|
||||||
|
|
|
@ -19,12 +19,8 @@ func init() {
|
||||||
NewFs: NewFs,
|
NewFs: NewFs,
|
||||||
Options: []fs.Option{{
|
Options: []fs.Option{{
|
||||||
Name: "namenode",
|
Name: "namenode",
|
||||||
Help: "Hadoop name node and port.",
|
Help: "Hadoop name node and port.\n\nE.g. \"namenode:8020\" to connect to host namenode at port 8020.",
|
||||||
Required: true,
|
Required: true,
|
||||||
Examples: []fs.OptionExample{{
|
|
||||||
Value: "namenode:8020",
|
|
||||||
Help: "Connect to host namenode at port 8020.",
|
|
||||||
}},
|
|
||||||
}, {
|
}, {
|
||||||
Name: "username",
|
Name: "username",
|
||||||
Help: "Hadoop user name.",
|
Help: "Hadoop user name.",
|
||||||
|
@ -38,12 +34,9 @@ func init() {
|
||||||
Help: `Kerberos service principal name for the namenode.
|
Help: `Kerberos service principal name for the namenode.
|
||||||
|
|
||||||
Enables KERBEROS authentication. Specifies the Service Principal Name
|
Enables KERBEROS authentication. Specifies the Service Principal Name
|
||||||
(SERVICE/FQDN) for the namenode.`,
|
(SERVICE/FQDN) for the namenode. E.g. \"hdfs/namenode.hadoop.docker\"
|
||||||
|
for namenode running as service 'hdfs' with FQDN 'namenode.hadoop.docker'.`,
|
||||||
Required: false,
|
Required: false,
|
||||||
Examples: []fs.OptionExample{{
|
|
||||||
Value: "hdfs/namenode.hadoop.docker",
|
|
||||||
Help: "Namenode running as service 'hdfs' with FQDN 'namenode.hadoop.docker'.",
|
|
||||||
}},
|
|
||||||
Advanced: true,
|
Advanced: true,
|
||||||
}, {
|
}, {
|
||||||
Name: "data_transfer_protection",
|
Name: "data_transfer_protection",
|
||||||
|
|
|
@ -38,15 +38,8 @@ func init() {
|
||||||
NewFs: NewFs,
|
NewFs: NewFs,
|
||||||
Options: []fs.Option{{
|
Options: []fs.Option{{
|
||||||
Name: "url",
|
Name: "url",
|
||||||
Help: "URL of http host to connect to.",
|
Help: "URL of http host to connect to.\n\nE.g. \"https://example.com\", or \"https://user:pass@example.com\" to use a username and password.",
|
||||||
Required: true,
|
Required: true,
|
||||||
Examples: []fs.OptionExample{{
|
|
||||||
Value: "https://example.com",
|
|
||||||
Help: "Connect to example.com.",
|
|
||||||
}, {
|
|
||||||
Value: "https://user:pass@example.com",
|
|
||||||
Help: "Connect to example.com using a username and password.",
|
|
||||||
}},
|
|
||||||
}, {
|
}, {
|
||||||
Name: "headers",
|
Name: "headers",
|
||||||
Help: `Set HTTP headers for all transactions.
|
Help: `Set HTTP headers for all transactions.
|
||||||
|
|
|
@ -56,12 +56,8 @@ func init() {
|
||||||
NewFs: NewFs,
|
NewFs: NewFs,
|
||||||
Options: []fs.Option{{
|
Options: []fs.Option{{
|
||||||
Name: "host",
|
Name: "host",
|
||||||
Help: "SSH host to connect to.",
|
Help: "SSH host to connect to.\n\nE.g. \"example.com\".",
|
||||||
Required: true,
|
Required: true,
|
||||||
Examples: []fs.OptionExample{{
|
|
||||||
Value: "example.com",
|
|
||||||
Help: "Connect to example.com.",
|
|
||||||
}},
|
|
||||||
}, {
|
}, {
|
||||||
Name: "user",
|
Name: "user",
|
||||||
Help: "SSH username, leave blank for current username, " + currentUser + ".",
|
Help: "SSH username, leave blank for current username, " + currentUser + ".",
|
||||||
|
|
|
@ -70,12 +70,8 @@ func init() {
|
||||||
NewFs: NewFs,
|
NewFs: NewFs,
|
||||||
Options: []fs.Option{{
|
Options: []fs.Option{{
|
||||||
Name: "url",
|
Name: "url",
|
||||||
Help: "URL of http host to connect to.",
|
Help: "URL of http host to connect to.\n\nE.g. https://example.com.",
|
||||||
Required: true,
|
Required: true,
|
||||||
Examples: []fs.OptionExample{{
|
|
||||||
Value: "https://example.com",
|
|
||||||
Help: "Connect to example.com.",
|
|
||||||
}},
|
|
||||||
}, {
|
}, {
|
||||||
Name: "vendor",
|
Name: "vendor",
|
||||||
Help: "Name of the Webdav site/service/software you are using.",
|
Help: "Name of the Webdav site/service/software you are using.",
|
||||||
|
|
Loading…
Reference in New Issue
Block a user