Fossil SCM

Clarified the "fossil help remote" output.

wyoung 2020-12-20 05:08 trunk
Commit 6d7b5c4a746109b2fdc5e55c098af631fa6427e8c50815c65ecc7ff08fcd3ee7
Parent 8b287e8d97f03cc…
1 file changed +32 -30
~ src/sync.c
M src/sync.c
+32 -30
--- src/sync.c
+++ src/sync.c
@@ -350,58 +350,60 @@
350350
 ** COMMAND: remote
351351
 ** COMMAND: remote-url*
352352
 **
353353
 ** Usage: %fossil remote ?SUBCOMMAND ...?
354354
 **
355
-** Use this command to view or modify the set of remote repositories
356
-** used as the default target for sync, push, and pull and for autosync.
357
-**
358
-** The default remote is set automatically by a "clone" command or by any
359
-** "sync", "push", or "pull" command that specifies an explicit URL
360
-** and omits the --once flag. The default remote is used by
361
-** auto-syncing and by "sync", "push", and "pull" that omit the server URL.
362
-** Additional remotes can be added using the "add" command or deleted
363
-** using the "delete" command. The name of any additional remote can be
364
-** used as an argument to the "sync", "push", and "pull" commands where
365
-** one would normally put a URL argument.
366
-**
367
-** See "fossil help clone" for further information about URL formats.
368
-**
369
-** The official name of this command is "remote-url" but most people
370
-** use the shortened name "remote".
355
+** View or modify the set of remote repository sync URLs used as the
356
+** target in any command that uses the sync protocol: "sync", "push",
357
+** and "pull", plus all other commands that trigger Fossil's autosync
358
+** feature. (Collectively, "sync operations".)
359
+**
360
+** See "fossil help clone" for the format of these sync URLs.
361
+**
362
+** Fossil implicitly sets the default remote sync URL from the initial
363
+** "clone" or "open URL" command for a repository, then may subsequently
364
+** change it when given a URL in commands that take a sync URL, except
365
+** when given the --once flag. Fossil uses this new sync URL as its
366
+** default when not explicitly given one in subsequent sync operations.
367
+**
368
+** Named remotes added by "remote add" allow use of those names in place
369
+** of a sync URL in any command that takes one.
370
+**
371
+** The full name of this command is "remote-url", but we anticipate no
372
+** future collision from use of its shortened form "remote".
371373
 **
372374
 ** > fossil remote
373375
 **
374
-** With no arguments, this command shows the current default remote.
375
-** Or if there is no default, it shows "off". The default remote is
376
-** used by autosync. The default remote is whatever URL was specified
377
-** for the most recent "sync", "push", or "pull" command that omitted
378
-** the --once option.
376
+** With no arguments, this command shows the current default remote
377
+** URL. If there is no default, it shows "off".
379378
 **
380379
 ** > fossil remote add NAME URL
381380
 **
382
-** Add a new URL to the set of remotes. The new URL is assigned the
383
-** symbolic identifier "NAME". Subsequently, NAME can be used in place
384
-** of the full URL on commands like "push" and "pull".
381
+** Add a new named URL to the set of remote sync URLs for use in
382
+** place of a sync URL in commands that take one.
385383
 **
386384
 ** > fossil remote delete NAME
387385
 **
388
-** Delete a URL previously added by the "add" subcommand.
386
+** Delete a sync URL previously added by the "add" subcommand.
389387
 **
390388
 ** > fossil remote list
391389
 **
392
-** Show all remote URLs
390
+** Show all remote repository sync URLs.
393391
 **
394392
 ** > fossil remote off
395393
 **
396
-** Disable the default URL. Use this as a shorthand to prevent
397
-** autosync while in airplane mode, for example.
394
+** Forget the default sync URL, disabling autosync. Combined with
395
+** named sync URLs, it allows canceling this "airplane mode" with
396
+** "fossil remote NAME" to select a previously-set named URL.
397
+**
398
+** To disable use of the default remote without forgetting its URL,
399
+** say "fossil set autosync 0" instead.
398400
 **
399401
 ** > fossil remote REF
400402
 **
401
-** Make REF the new default URL. The prior default URL is replaced.
402
-** REF can be either an explicit URL or a NAME from a prior "add".
403
+** Make REF the new default URL, replacing the prior default.
404
+** REF may be a URL or a NAME from a prior "add".
403405
 */
404406
 void remote_url_cmd(void){
405407
 char *zUrl, *zArg;
406408
 int nArg;
407409
 db_find_and_open_repository(0, 0);
408410
--- src/sync.c
+++ src/sync.c
@@ -350,58 +350,60 @@
350 ** COMMAND: remote
351 ** COMMAND: remote-url*
352 **
353 ** Usage: %fossil remote ?SUBCOMMAND ...?
354 **
355 ** Use this command to view or modify the set of remote repositories
356 ** used as the default target for sync, push, and pull and for autosync.
357 **
358 ** The default remote is set automatically by a "clone" command or by any
359 ** "sync", "push", or "pull" command that specifies an explicit URL
360 ** and omits the --once flag. The default remote is used by
361 ** auto-syncing and by "sync", "push", and "pull" that omit the server URL.
362 ** Additional remotes can be added using the "add" command or deleted
363 ** using the "delete" command. The name of any additional remote can be
364 ** used as an argument to the "sync", "push", and "pull" commands where
365 ** one would normally put a URL argument.
366 **
367 ** See "fossil help clone" for further information about URL formats.
368 **
369 ** The official name of this command is "remote-url" but most people
370 ** use the shortened name "remote".
 
 
371 **
372 ** > fossil remote
373 **
374 ** With no arguments, this command shows the current default remote.
375 ** Or if there is no default, it shows "off". The default remote is
376 ** used by autosync. The default remote is whatever URL was specified
377 ** for the most recent "sync", "push", or "pull" command that omitted
378 ** the --once option.
379 **
380 ** > fossil remote add NAME URL
381 **
382 ** Add a new URL to the set of remotes. The new URL is assigned the
383 ** symbolic identifier "NAME". Subsequently, NAME can be used in place
384 ** of the full URL on commands like "push" and "pull".
385 **
386 ** > fossil remote delete NAME
387 **
388 ** Delete a URL previously added by the "add" subcommand.
389 **
390 ** > fossil remote list
391 **
392 ** Show all remote URLs
393 **
394 ** > fossil remote off
395 **
396 ** Disable the default URL. Use this as a shorthand to prevent
397 ** autosync while in airplane mode, for example.
 
 
 
 
398 **
399 ** > fossil remote REF
400 **
401 ** Make REF the new default URL. The prior default URL is replaced.
402 ** REF can be either an explicit URL or a NAME from a prior "add".
403 */
404 void remote_url_cmd(void){
405 char *zUrl, *zArg;
406 int nArg;
407 db_find_and_open_repository(0, 0);
408
--- src/sync.c
+++ src/sync.c
@@ -350,58 +350,60 @@
350 ** COMMAND: remote
351 ** COMMAND: remote-url*
352 **
353 ** Usage: %fossil remote ?SUBCOMMAND ...?
354 **
355 ** View or modify the set of remote repository sync URLs used as the
356 ** target in any command that uses the sync protocol: "sync", "push",
357 ** and "pull", plus all other commands that trigger Fossil's autosync
358 ** feature. (Collectively, "sync operations".)
359 **
360 ** See "fossil help clone" for the format of these sync URLs.
361 **
362 ** Fossil implicitly sets the default remote sync URL from the initial
363 ** "clone" or "open URL" command for a repository, then may subsequently
364 ** change it when given a URL in commands that take a sync URL, except
365 ** when given the --once flag. Fossil uses this new sync URL as its
366 ** default when not explicitly given one in subsequent sync operations.
367 **
368 ** Named remotes added by "remote add" allow use of those names in place
369 ** of a sync URL in any command that takes one.
370 **
371 ** The full name of this command is "remote-url", but we anticipate no
372 ** future collision from use of its shortened form "remote".
373 **
374 ** > fossil remote
375 **
376 ** With no arguments, this command shows the current default remote
377 ** URL. If there is no default, it shows "off".
 
 
 
378 **
379 ** > fossil remote add NAME URL
380 **
381 ** Add a new named URL to the set of remote sync URLs for use in
382 ** place of a sync URL in commands that take one.
 
383 **
384 ** > fossil remote delete NAME
385 **
386 ** Delete a sync URL previously added by the "add" subcommand.
387 **
388 ** > fossil remote list
389 **
390 ** Show all remote repository sync URLs.
391 **
392 ** > fossil remote off
393 **
394 ** Forget the default sync URL, disabling autosync. Combined with
395 ** named sync URLs, it allows canceling this "airplane mode" with
396 ** "fossil remote NAME" to select a previously-set named URL.
397 **
398 ** To disable use of the default remote without forgetting its URL,
399 ** say "fossil set autosync 0" instead.
400 **
401 ** > fossil remote REF
402 **
403 ** Make REF the new default URL, replacing the prior default.
404 ** REF may be a URL or a NAME from a prior "add".
405 */
406 void remote_url_cmd(void){
407 char *zUrl, *zArg;
408 int nArg;
409 db_find_and_open_repository(0, 0);
410

Keyboard Shortcuts

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