Fossil SCM

Improved command-line help for push, pull, sync, and clone commands.

drh 2015-12-02 09:50 trunk
Commit 26d0c20a37b014ccb8365b94ed2044ecd6a39cbc
Parent 069084afc2bcd21…
2 files changed +4 -4 +75 -56
~ src/clone.c ~ src/sync.c
M src/clone.c
+4 -4
--- src/clone.c
+++ src/clone.c
@@ -105,15 +105,15 @@
105105
 ** admin user. This can be overridden using the -A|--admin-user
106106
 ** parameter.
107107
 **
108108
 ** Options:
109109
 ** --admin-user|-A USERNAME Make USERNAME the administrator
110
-** --once Don't save url.
110
+** --once Don't remember the URL.
111111
 ** --private Also clone private branches
112
-** --ssl-identity=filename Use the SSL identity if requested by the server
113
-** --ssh-command|-c 'command' Use this SSH command
114
-** --httpauth|-B 'user:pass' Add HTTP Basic Authorization to requests
112
+** --ssl-identity FILENAME Use the SSL identity if requested by the server
113
+** --ssh-command|-c SSH Use SSH as the "ssh" command
114
+** --httpauth|-B USER:PASS Add HTTP Basic Authorization to requests
115115
 ** --verbose Show more statistics in output
116116
 **
117117
 ** See also: init
118118
 */
119119
 void clone_cmd(void){
120120
--- src/clone.c
+++ src/clone.c
@@ -105,15 +105,15 @@
105 ** admin user. This can be overridden using the -A|--admin-user
106 ** parameter.
107 **
108 ** Options:
109 ** --admin-user|-A USERNAME Make USERNAME the administrator
110 ** --once Don't save url.
111 ** --private Also clone private branches
112 ** --ssl-identity=filename Use the SSL identity if requested by the server
113 ** --ssh-command|-c 'command' Use this SSH command
114 ** --httpauth|-B 'user:pass' Add HTTP Basic Authorization to requests
115 ** --verbose Show more statistics in output
116 **
117 ** See also: init
118 */
119 void clone_cmd(void){
120
--- src/clone.c
+++ src/clone.c
@@ -105,15 +105,15 @@
105 ** admin user. This can be overridden using the -A|--admin-user
106 ** parameter.
107 **
108 ** Options:
109 ** --admin-user|-A USERNAME Make USERNAME the administrator
110 ** --once Don't remember the URL.
111 ** --private Also clone private branches
112 ** --ssl-identity FILENAME Use the SSL identity if requested by the server
113 ** --ssh-command|-c SSH Use SSH as the "ssh" command
114 ** --httpauth|-B USER:PASS Add HTTP Basic Authorization to requests
115 ** --verbose Show more statistics in output
116 **
117 ** See also: init
118 */
119 void clone_cmd(void){
120
M src/sync.c
+75 -56
--- src/sync.c
+++ src/sync.c
@@ -163,28 +163,35 @@
163163
 /*
164164
 ** COMMAND: pull
165165
 **
166166
 ** Usage: %fossil pull ?URL? ?options?
167167
 **
168
-** Pull changes from a remote repository into the local repository.
169
-** Use the "-R REPO" or "--repository REPO" command-line options
170
-** to specify an alternative repository file.
171
-**
172
-** See clone usage for possible URL formats.
173
-**
174
-** If the URL is not specified, then the URL from the most recent
175
-** clone, push, pull, remote-url, or sync command is used.
176
-**
177
-** The URL specified normally becomes the new "remote-url" used for
178
-** subsequent push, pull, and sync operations. However, the "--once"
179
-** command-line option makes the URL a one-time-use URL that is not
180
-** saved.
181
-**
182
-** Use the --private option to pull private branches from the
183
-** remote repository.
184
-**
185
-** See also: clone, push, sync, remote-url
168
+** Pull all sharable changes from a remote repository into the local repository.
169
+** Sharable changes include public check-ins, and wiki, ticket, and tech-note
170
+** edits. Add the --private option to pull private branches. Use the
171
+** "configuration pull" command to pull website configuration details.
172
+**
173
+** If URL is not specified, then the URL from the most recent clone, push,
174
+** pull, remote-url, or sync command is used. See "fossil help clone" for
175
+** details on the URL formats.
176
+**
177
+** Options:
178
+**
179
+** -B|--httpauth USER:PASS Credentials for the simple HTTP auth protocol,
180
+** if required by the remote website
181
+** --ipv4 Use only IPv4, not IPv6
182
+** --once Do not remember URL for subsequent syncs
183
+** --proxy PROXY Use the specified HTTP proxy
184
+** --private Pull private branches too
185
+** -R|--repository REPO Repository to pull into
186
+** --ssl-identity FILE Local SSL credentials, if requested by remote
187
+** --ssh-command SSH Use SSH as the "ssh" command
188
+** -v|--verbose Additional (debugging) output
189
+** --verily Exchange extra information with the remote
190
+** to ensure no content is overlooked
191
+**
192
+** See also: clone, config pull, push, remote-url, sync
186193
 */
187194
 void pull_cmd(void){
188195
 unsigned configFlags = 0;
189196
 unsigned syncFlags = SYNC_PULL;
190197
 process_sync_args(&configFlags, &syncFlags);
@@ -198,28 +205,35 @@
198205
 /*
199206
 ** COMMAND: push
200207
 **
201208
 ** Usage: %fossil push ?URL? ?options?
202209
 **
203
-** Push changes in the local repository over into a remote repository.
204
-** Use the "-R REPO" or "--repository REPO" command-line options
205
-** to specify an alternative repository file.
206
-**
207
-** See clone usage for possible URL formats.
208
-**
209
-** If the URL is not specified, then the URL from the most recent
210
-** clone, push, pull, remote-url, or sync command is used.
211
-**
212
-** The URL specified normally becomes the new "remote-url" used for
213
-** subsequent push, pull, and sync operations. However, the "--once"
214
-** command-line option makes the URL a one-time-use URL that is not
215
-** saved.
216
-**
217
-** Use the --private option to push private branches to the
218
-** remote repository.
219
-**
220
-** See also: clone, pull, sync, remote-url
210
+** Push all sharable changes from the local repository to a remote repository.
211
+** Sharable changes include public check-ins, and wiki, ticket, and tech-note
212
+** edits. Use --private to also push private branches. Use the
213
+** "configuration pull" command to push website configuration details.
214
+**
215
+** If URL is not specified, then the URL from the most recent clone, push,
216
+** pull, remote-url, or sync command is used. See "fossil help clone" for
217
+** details on the URL formats.
218
+**
219
+** Options:
220
+**
221
+** -B|--httpauth USER:PASS Credentials for the simple HTTP auth protocol,
222
+** if required by the remote website
223
+** --ipv4 Use only IPv4, not IPv6
224
+** --once Do not remember URL for subsequent syncs
225
+** --proxy PROXY Use the specified HTTP proxy
226
+** --private Pull private branches too
227
+** -R|--repository REPO Repository to pull into
228
+** --ssl-identity FILE Local SSL credentials, if requested by remote
229
+** --ssh-command SSH Use SSH as the "ssh" command
230
+** -v|--verbose Additional (debugging) output
231
+** --verily Exchange extra information with the remote
232
+** to ensure no content is overlooked
233
+**
234
+** See also: clone, config push, pull, remote-url, sync
221235
 */
222236
 void push_cmd(void){
223237
 unsigned configFlags = 0;
224238
 unsigned syncFlags = SYNC_PUSH;
225239
 process_sync_args(&configFlags, &syncFlags);
@@ -237,29 +251,34 @@
237251
 /*
238252
 ** COMMAND: sync
239253
 **
240254
 ** Usage: %fossil sync ?URL? ?options?
241255
 **
242
-** Synchronize the local repository with a remote repository. This is
243
-** the equivalent of running both "push" and "pull" at the same time.
244
-** Use the "-R REPO" or "--repository REPO" command-line options
245
-** to specify an alternative repository file.
246
-**
247
-** See clone usage for possible URL formats.
248
-**
249
-** If the URL is not specified, then the URL from the most recent
250
-** successful clone, push, pull, remote-url, or sync command is used.
251
-**
252
-** The URL specified normally becomes the new "remote-url" used for
253
-** subsequent push, pull, and sync operations. However, the "--once"
254
-** command-line option makes the URL a one-time-use URL that is not
255
-** saved.
256
-**
257
-** Use the --private option to sync private branches with the
258
-** remote repository.
259
-**
260
-** See also: clone, push, pull, remote-url
256
+** Synchronize all sharable changes between the local repository and a
257
+** a remote repository. Sharable changes include public check-ins, and wiki,
258
+** ticket, and tech-note edits.
259
+**
260
+** If URL is not specified, then the URL from the most recent clone, push,
261
+** pull, remote-url, or sync command is used. See "fossil help clone" for
262
+** details on the URL formats.
263
+**
264
+** Options:
265
+**
266
+** -B|--httpauth USER:PASS Credentials for the simple HTTP auth protocol,
267
+** if required by the remote website
268
+** --ipv4 Use only IPv4, not IPv6
269
+** --once Do not remember URL for subsequent syncs
270
+** --proxy PROXY Use the specified HTTP proxy
271
+** --private Pull private branches too
272
+** -R|--repository REPO Repository to pull into
273
+** --ssl-identity FILE Local SSL credentials, if requested by remote
274
+** --ssh-command SSH Use SSH as the "ssh" command
275
+** -v|--verbose Additional (debugging) output
276
+** --verily Exchange extra information with the remote
277
+** to ensure no content is overlooked
278
+**
279
+** See also: clone, pull, push, remote-url
261280
 */
262281
 void sync_cmd(void){
263282
 unsigned configFlags = 0;
264283
 unsigned syncFlags = SYNC_PUSH|SYNC_PULL;
265284
 process_sync_args(&configFlags, &syncFlags);
@@ -285,11 +304,11 @@
285304
 ** The remote-url is set automatically by a "clone" command or by any
286305
 ** "sync", "push", or "pull" command that specifies an explicit URL.
287306
 ** The default remote-url is used by auto-syncing and by "sync", "push",
288307
 ** "pull" that omit the server URL.
289308
 **
290
-** See clone usage for possible URL formats.
309
+** See "fossil help clone" for further information about URL formats
291310
 **
292311
 ** See also: clone, push, pull, sync
293312
 */
294313
 void remote_url_cmd(void){
295314
 char *zUrl;
296315
--- src/sync.c
+++ src/sync.c
@@ -163,28 +163,35 @@
163 /*
164 ** COMMAND: pull
165 **
166 ** Usage: %fossil pull ?URL? ?options?
167 **
168 ** Pull changes from a remote repository into the local repository.
169 ** Use the "-R REPO" or "--repository REPO" command-line options
170 ** to specify an alternative repository file.
171 **
172 ** See clone usage for possible URL formats.
173 **
174 ** If the URL is not specified, then the URL from the most recent
175 ** clone, push, pull, remote-url, or sync command is used.
176 **
177 ** The URL specified normally becomes the new "remote-url" used for
178 ** subsequent push, pull, and sync operations. However, the "--once"
179 ** command-line option makes the URL a one-time-use URL that is not
180 ** saved.
181 **
182 ** Use the --private option to pull private branches from the
183 ** remote repository.
184 **
185 ** See also: clone, push, sync, remote-url
 
 
 
 
 
 
 
186 */
187 void pull_cmd(void){
188 unsigned configFlags = 0;
189 unsigned syncFlags = SYNC_PULL;
190 process_sync_args(&configFlags, &syncFlags);
@@ -198,28 +205,35 @@
198 /*
199 ** COMMAND: push
200 **
201 ** Usage: %fossil push ?URL? ?options?
202 **
203 ** Push changes in the local repository over into a remote repository.
204 ** Use the "-R REPO" or "--repository REPO" command-line options
205 ** to specify an alternative repository file.
206 **
207 ** See clone usage for possible URL formats.
208 **
209 ** If the URL is not specified, then the URL from the most recent
210 ** clone, push, pull, remote-url, or sync command is used.
211 **
212 ** The URL specified normally becomes the new "remote-url" used for
213 ** subsequent push, pull, and sync operations. However, the "--once"
214 ** command-line option makes the URL a one-time-use URL that is not
215 ** saved.
216 **
217 ** Use the --private option to push private branches to the
218 ** remote repository.
219 **
220 ** See also: clone, pull, sync, remote-url
 
 
 
 
 
 
 
221 */
222 void push_cmd(void){
223 unsigned configFlags = 0;
224 unsigned syncFlags = SYNC_PUSH;
225 process_sync_args(&configFlags, &syncFlags);
@@ -237,29 +251,34 @@
237 /*
238 ** COMMAND: sync
239 **
240 ** Usage: %fossil sync ?URL? ?options?
241 **
242 ** Synchronize the local repository with a remote repository. This is
243 ** the equivalent of running both "push" and "pull" at the same time.
244 ** Use the "-R REPO" or "--repository REPO" command-line options
245 ** to specify an alternative repository file.
246 **
247 ** See clone usage for possible URL formats.
248 **
249 ** If the URL is not specified, then the URL from the most recent
250 ** successful clone, push, pull, remote-url, or sync command is used.
251 **
252 ** The URL specified normally becomes the new "remote-url" used for
253 ** subsequent push, pull, and sync operations. However, the "--once"
254 ** command-line option makes the URL a one-time-use URL that is not
255 ** saved.
256 **
257 ** Use the --private option to sync private branches with the
258 ** remote repository.
259 **
260 ** See also: clone, push, pull, remote-url
 
 
 
 
 
261 */
262 void sync_cmd(void){
263 unsigned configFlags = 0;
264 unsigned syncFlags = SYNC_PUSH|SYNC_PULL;
265 process_sync_args(&configFlags, &syncFlags);
@@ -285,11 +304,11 @@
285 ** The remote-url is set automatically by a "clone" command or by any
286 ** "sync", "push", or "pull" command that specifies an explicit URL.
287 ** The default remote-url is used by auto-syncing and by "sync", "push",
288 ** "pull" that omit the server URL.
289 **
290 ** See clone usage for possible URL formats.
291 **
292 ** See also: clone, push, pull, sync
293 */
294 void remote_url_cmd(void){
295 char *zUrl;
296
--- src/sync.c
+++ src/sync.c
@@ -163,28 +163,35 @@
163 /*
164 ** COMMAND: pull
165 **
166 ** Usage: %fossil pull ?URL? ?options?
167 **
168 ** Pull all sharable changes from a remote repository into the local repository.
169 ** Sharable changes include public check-ins, and wiki, ticket, and tech-note
170 ** edits. Add the --private option to pull private branches. Use the
171 ** "configuration pull" command to pull website configuration details.
172 **
173 ** If URL is not specified, then the URL from the most recent clone, push,
174 ** pull, remote-url, or sync command is used. See "fossil help clone" for
175 ** details on the URL formats.
176 **
177 ** Options:
178 **
179 ** -B|--httpauth USER:PASS Credentials for the simple HTTP auth protocol,
180 ** if required by the remote website
181 ** --ipv4 Use only IPv4, not IPv6
182 ** --once Do not remember URL for subsequent syncs
183 ** --proxy PROXY Use the specified HTTP proxy
184 ** --private Pull private branches too
185 ** -R|--repository REPO Repository to pull into
186 ** --ssl-identity FILE Local SSL credentials, if requested by remote
187 ** --ssh-command SSH Use SSH as the "ssh" command
188 ** -v|--verbose Additional (debugging) output
189 ** --verily Exchange extra information with the remote
190 ** to ensure no content is overlooked
191 **
192 ** See also: clone, config pull, push, remote-url, sync
193 */
194 void pull_cmd(void){
195 unsigned configFlags = 0;
196 unsigned syncFlags = SYNC_PULL;
197 process_sync_args(&configFlags, &syncFlags);
@@ -198,28 +205,35 @@
205 /*
206 ** COMMAND: push
207 **
208 ** Usage: %fossil push ?URL? ?options?
209 **
210 ** Push all sharable changes from the local repository to a remote repository.
211 ** Sharable changes include public check-ins, and wiki, ticket, and tech-note
212 ** edits. Use --private to also push private branches. Use the
213 ** "configuration pull" command to push website configuration details.
214 **
215 ** If URL is not specified, then the URL from the most recent clone, push,
216 ** pull, remote-url, or sync command is used. See "fossil help clone" for
217 ** details on the URL formats.
218 **
219 ** Options:
220 **
221 ** -B|--httpauth USER:PASS Credentials for the simple HTTP auth protocol,
222 ** if required by the remote website
223 ** --ipv4 Use only IPv4, not IPv6
224 ** --once Do not remember URL for subsequent syncs
225 ** --proxy PROXY Use the specified HTTP proxy
226 ** --private Pull private branches too
227 ** -R|--repository REPO Repository to pull into
228 ** --ssl-identity FILE Local SSL credentials, if requested by remote
229 ** --ssh-command SSH Use SSH as the "ssh" command
230 ** -v|--verbose Additional (debugging) output
231 ** --verily Exchange extra information with the remote
232 ** to ensure no content is overlooked
233 **
234 ** See also: clone, config push, pull, remote-url, sync
235 */
236 void push_cmd(void){
237 unsigned configFlags = 0;
238 unsigned syncFlags = SYNC_PUSH;
239 process_sync_args(&configFlags, &syncFlags);
@@ -237,29 +251,34 @@
251 /*
252 ** COMMAND: sync
253 **
254 ** Usage: %fossil sync ?URL? ?options?
255 **
256 ** Synchronize all sharable changes between the local repository and a
257 ** a remote repository. Sharable changes include public check-ins, and wiki,
258 ** ticket, and tech-note edits.
259 **
260 ** If URL is not specified, then the URL from the most recent clone, push,
261 ** pull, remote-url, or sync command is used. See "fossil help clone" for
262 ** details on the URL formats.
263 **
264 ** Options:
265 **
266 ** -B|--httpauth USER:PASS Credentials for the simple HTTP auth protocol,
267 ** if required by the remote website
268 ** --ipv4 Use only IPv4, not IPv6
269 ** --once Do not remember URL for subsequent syncs
270 ** --proxy PROXY Use the specified HTTP proxy
271 ** --private Pull private branches too
272 ** -R|--repository REPO Repository to pull into
273 ** --ssl-identity FILE Local SSL credentials, if requested by remote
274 ** --ssh-command SSH Use SSH as the "ssh" command
275 ** -v|--verbose Additional (debugging) output
276 ** --verily Exchange extra information with the remote
277 ** to ensure no content is overlooked
278 **
279 ** See also: clone, pull, push, remote-url
280 */
281 void sync_cmd(void){
282 unsigned configFlags = 0;
283 unsigned syncFlags = SYNC_PUSH|SYNC_PULL;
284 process_sync_args(&configFlags, &syncFlags);
@@ -285,11 +304,11 @@
304 ** The remote-url is set automatically by a "clone" command or by any
305 ** "sync", "push", or "pull" command that specifies an explicit URL.
306 ** The default remote-url is used by auto-syncing and by "sync", "push",
307 ** "pull" that omit the server URL.
308 **
309 ** See "fossil help clone" for further information about URL formats
310 **
311 ** See also: clone, push, pull, sync
312 */
313 void remote_url_cmd(void){
314 char *zUrl;
315

Keyboard Shortcuts

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