Fossil SCM

More refinements to built-in help pages for commands.

drh 2020-08-09 00:04 trunk
Commit a31a717e177e9f8cfe3b218023d9d122fb3c05c14b11930e12af65bd728c318c
2 files changed +8 -6 +3 -3
+8 -6
--- src/clone.c
+++ src/clone.c
@@ -83,13 +83,11 @@
8383
** COMMAND: clone
8484
**
8585
** Usage: %fossil clone ?OPTIONS? URI FILENAME
8686
**
8787
** Make a clone of a repository specified by URI in the local
88
-** file named FILENAME.
89
-**
90
-** URI may be one of the following forms:
88
+** file named FILENAME. URI may be one of the following forms:
9189
** ([...] denotes optional elements):
9290
**
9391
** * HTTP/HTTPS protocol:
9492
**
9593
** http[s]://[userid[:password]@]host[:port][/path]
@@ -100,18 +98,22 @@
10098
**
10199
** * Filesystem:
102100
**
103101
** [file://]path/to/repo.fossil
104102
**
105
-** Note 1: For ssh and filesystem, path must have an extra leading
103
+** Note that in Fossil (in contrast to some other DVCSes) a repository
104
+** is distinct from a checkout. This command create a clone of a repository.
105
+** Use the separate [[open]] command to open a checkout from that repository.
106
+**
107
+** For ssh and filesystem, path must have an extra leading
106108
** '/' to use an absolute path.
107109
**
108
-** Note 2: Use %HH escapes for special characters in the userid and
110
+** Use %HH escapes for special characters in the userid and
109111
** password. For example "%40" in place of "@", "%2f" in place
110112
** of "/", and "%3a" in place of ":".
111113
**
112
-** By default, your current login name is used to create the default
114
+** By default, the current login name is used to create the default
113115
** admin user. This can be overridden using the -A|--admin-user
114116
** parameter.
115117
**
116118
** Options:
117119
** --admin-user|-A USERNAME Make USERNAME the administrator
118120
--- src/clone.c
+++ src/clone.c
@@ -83,13 +83,11 @@
83 ** COMMAND: clone
84 **
85 ** Usage: %fossil clone ?OPTIONS? URI FILENAME
86 **
87 ** Make a clone of a repository specified by URI in the local
88 ** file named FILENAME.
89 **
90 ** URI may be one of the following forms:
91 ** ([...] denotes optional elements):
92 **
93 ** * HTTP/HTTPS protocol:
94 **
95 ** http[s]://[userid[:password]@]host[:port][/path]
@@ -100,18 +98,22 @@
100 **
101 ** * Filesystem:
102 **
103 ** [file://]path/to/repo.fossil
104 **
105 ** Note 1: For ssh and filesystem, path must have an extra leading
 
 
 
 
106 ** '/' to use an absolute path.
107 **
108 ** Note 2: Use %HH escapes for special characters in the userid and
109 ** password. For example "%40" in place of "@", "%2f" in place
110 ** of "/", and "%3a" in place of ":".
111 **
112 ** By default, your current login name is used to create the default
113 ** admin user. This can be overridden using the -A|--admin-user
114 ** parameter.
115 **
116 ** Options:
117 ** --admin-user|-A USERNAME Make USERNAME the administrator
118
--- src/clone.c
+++ src/clone.c
@@ -83,13 +83,11 @@
83 ** COMMAND: clone
84 **
85 ** Usage: %fossil clone ?OPTIONS? URI FILENAME
86 **
87 ** Make a clone of a repository specified by URI in the local
88 ** file named FILENAME. URI may be one of the following forms:
 
 
89 ** ([...] denotes optional elements):
90 **
91 ** * HTTP/HTTPS protocol:
92 **
93 ** http[s]://[userid[:password]@]host[:port][/path]
@@ -100,18 +98,22 @@
98 **
99 ** * Filesystem:
100 **
101 ** [file://]path/to/repo.fossil
102 **
103 ** Note that in Fossil (in contrast to some other DVCSes) a repository
104 ** is distinct from a checkout. This command create a clone of a repository.
105 ** Use the separate [[open]] command to open a checkout from that repository.
106 **
107 ** For ssh and filesystem, path must have an extra leading
108 ** '/' to use an absolute path.
109 **
110 ** Use %HH escapes for special characters in the userid and
111 ** password. For example "%40" in place of "@", "%2f" in place
112 ** of "/", and "%3a" in place of ":".
113 **
114 ** By default, the current login name is used to create the default
115 ** admin user. This can be overridden using the -A|--admin-user
116 ** parameter.
117 **
118 ** Options:
119 ** --admin-user|-A USERNAME Make USERNAME the administrator
120
+3 -3
--- src/db.c
+++ src/db.c
@@ -3090,14 +3090,14 @@
30903090
**
30913091
** REPOSITORY can be the filename for a repository that already exists on the
30923092
** local machine or it can be a URI for a remote repository. If REPOSITORY
30933093
** is a URI in one of the formats recognized by the [[clone]] command, then
30943094
** remote repo is first cloned, then the clone is opened. The clone will be
3095
-** stored in the current directory, or in DIR if the "--workdir DIR" option
3095
+** stored in the current directory, or in DIR if the "--repodir DIR" option
30963096
** is used. The name of the clone will be taken from the last term of the URI.
3097
-** For "http:" and "https:" URIs, you can append an extra term on the end to
3098
-** get any repository name you like. For example:
3097
+** For "http:" and "https:" URIs, you can append an extra term to the end of
3098
+** the URI to get any repository name you like. For example:
30993099
**
31003100
** fossil open https://fossil-scm.org/home/new-name
31013101
**
31023102
** The base URI for cloning is "https://fossil-scm.org/home". The extra
31033103
** "new-name" term means that the cloned repository will be called
31043104
--- src/db.c
+++ src/db.c
@@ -3090,14 +3090,14 @@
3090 **
3091 ** REPOSITORY can be the filename for a repository that already exists on the
3092 ** local machine or it can be a URI for a remote repository. If REPOSITORY
3093 ** is a URI in one of the formats recognized by the [[clone]] command, then
3094 ** remote repo is first cloned, then the clone is opened. The clone will be
3095 ** stored in the current directory, or in DIR if the "--workdir DIR" option
3096 ** is used. The name of the clone will be taken from the last term of the URI.
3097 ** For "http:" and "https:" URIs, you can append an extra term on the end to
3098 ** get any repository name you like. For example:
3099 **
3100 ** fossil open https://fossil-scm.org/home/new-name
3101 **
3102 ** The base URI for cloning is "https://fossil-scm.org/home". The extra
3103 ** "new-name" term means that the cloned repository will be called
3104
--- src/db.c
+++ src/db.c
@@ -3090,14 +3090,14 @@
3090 **
3091 ** REPOSITORY can be the filename for a repository that already exists on the
3092 ** local machine or it can be a URI for a remote repository. If REPOSITORY
3093 ** is a URI in one of the formats recognized by the [[clone]] command, then
3094 ** remote repo is first cloned, then the clone is opened. The clone will be
3095 ** stored in the current directory, or in DIR if the "--repodir DIR" option
3096 ** is used. The name of the clone will be taken from the last term of the URI.
3097 ** For "http:" and "https:" URIs, you can append an extra term to the end of
3098 ** the URI to get any repository name you like. For example:
3099 **
3100 ** fossil open https://fossil-scm.org/home/new-name
3101 **
3102 ** The base URI for cloning is "https://fossil-scm.org/home". The extra
3103 ** "new-name" term means that the cloned repository will be called
3104

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button