Fossil SCM
Improvements to the on-line help text for the "fossil remote" command.
Commit
bbf17aeb87ab0a0d121a5a9cb2bc0f6931073c7fb92b92046eeac0807a0cd987
Parent
bcb09d6511ca740…
1 file changed
+27
-27
+27
-27
| --- src/sync.c | ||
| +++ src/sync.c | ||
| @@ -470,55 +470,55 @@ | ||
| 470 | 470 | ** COMMAND: remote |
| 471 | 471 | ** COMMAND: remote-url* |
| 472 | 472 | ** |
| 473 | 473 | ** Usage: %fossil remote ?SUBCOMMAND ...? |
| 474 | 474 | ** |
| 475 | -** View or modify the set of remote repository sync URLs used as the | |
| 476 | -** target in any command that uses the sync protocol: "sync", "push", | |
| 477 | -** and "pull", plus all other commands that trigger Fossil's autosync | |
| 478 | -** feature. (Collectively, "sync operations".) | |
| 479 | -** | |
| 480 | -** See "fossil help clone" for the format of these sync URLs. | |
| 481 | -** | |
| 482 | -** Fossil implicitly sets the default remote sync URL from the initial | |
| 483 | -** "clone" or "open URL" command for a repository, then may subsequently | |
| 484 | -** change it when given a URL in commands that take a sync URL, except | |
| 485 | -** when given the --once flag. Fossil uses this new sync URL as its | |
| 486 | -** default when not explicitly given one in subsequent sync operations. | |
| 487 | -** | |
| 488 | -** Named remotes added by "remote add" allow use of those names in place | |
| 489 | -** of a sync URL in any command that takes one. | |
| 490 | -** | |
| 491 | -** The full name of this command is "remote-url", but we anticipate no | |
| 492 | -** future collision from use of its shortened form "remote". | |
| 475 | +** View or modify the URLs of remote repositories used for syncing. | |
| 476 | +** The "default" remote is the URL used in the most recent "sync", | |
| 477 | +** "push", "pull", "clone", or similar command. The default remote can | |
| 478 | +** change with each sync command. Other named remotes are persistent. | |
| 493 | 479 | ** |
| 494 | 480 | ** > fossil remote |
| 495 | 481 | ** |
| 496 | 482 | ** With no arguments, this command shows the current default remote |
| 497 | 483 | ** URL. If there is no default, it shows "off". |
| 498 | 484 | ** |
| 499 | 485 | ** > fossil remote add NAME URL |
| 500 | 486 | ** |
| 501 | -** Add a new named URL to the set of remote sync URLs for use in | |
| 502 | -** place of a sync URL in commands that take one. | |
| 487 | +** Add a new named URL. Afterwards, NAME can be used as a short | |
| 488 | +** symbolic name for URL in contexts where a URL is required. The | |
| 489 | +** URL argument can be "default" or a prior symbolic name, to make | |
| 490 | +** a copy of an existing URL under a new name. | |
| 491 | +** | |
| 492 | +** > fossil config-data | |
| 493 | +** | |
| 494 | +** DEBUG USE ONLY - Show the name and value of every CONFIG table | |
| 495 | +** entry in the repository that is associated with the remote URL store. | |
| 496 | +** Passwords are obscured in the output. | |
| 503 | 497 | ** |
| 504 | 498 | ** > fossil remote delete NAME |
| 505 | 499 | ** |
| 506 | -** Delete a sync URL previously added by the "add" subcommand. | |
| 500 | +** Delete a named URL previously created by the "add" subcommand. | |
| 507 | 501 | ** |
| 508 | 502 | ** > fossil remote list|ls |
| 509 | 503 | ** |
| 510 | -** Show all remote repository sync URLs. | |
| 504 | +** Show all remote repository URLs. | |
| 511 | 505 | ** |
| 512 | 506 | ** > fossil remote off |
| 513 | 507 | ** |
| 514 | -** Forget the default sync URL, disabling autosync. Combined with | |
| 515 | -** named sync URLs, it allows canceling this "airplane mode" with | |
| 516 | -** "fossil remote NAME" to select a previously-set named URL. | |
| 508 | +** Forget the default URL. This disables autosync. | |
| 509 | +** | |
| 510 | +** This is a convenient way to enter "airplane mode". To enter | |
| 511 | +** airplane mode, first save the current default URL, then turn the | |
| 512 | +** default off. Perhaps like this: | |
| 513 | +** | |
| 514 | +** fossil remote add main default | |
| 515 | +** fossil remote off | |
| 516 | +** | |
| 517 | +** To exit airplane mode and turn autosync back on again: | |
| 517 | 518 | ** |
| 518 | -** To disable use of the default remote without forgetting its URL, | |
| 519 | -** say "fossil set autosync 0" instead. | |
| 519 | +** fossil remote main | |
| 520 | 520 | ** |
| 521 | 521 | ** > fossil remote scrub |
| 522 | 522 | ** |
| 523 | 523 | ** Forget any saved passwords for remote repositories, but continue |
| 524 | 524 | ** to remember the URLs themselves. You will be prompted for the |
| 525 | 525 |
| --- src/sync.c | |
| +++ src/sync.c | |
| @@ -470,55 +470,55 @@ | |
| 470 | ** COMMAND: remote |
| 471 | ** COMMAND: remote-url* |
| 472 | ** |
| 473 | ** Usage: %fossil remote ?SUBCOMMAND ...? |
| 474 | ** |
| 475 | ** View or modify the set of remote repository sync URLs used as the |
| 476 | ** target in any command that uses the sync protocol: "sync", "push", |
| 477 | ** and "pull", plus all other commands that trigger Fossil's autosync |
| 478 | ** feature. (Collectively, "sync operations".) |
| 479 | ** |
| 480 | ** See "fossil help clone" for the format of these sync URLs. |
| 481 | ** |
| 482 | ** Fossil implicitly sets the default remote sync URL from the initial |
| 483 | ** "clone" or "open URL" command for a repository, then may subsequently |
| 484 | ** change it when given a URL in commands that take a sync URL, except |
| 485 | ** when given the --once flag. Fossil uses this new sync URL as its |
| 486 | ** default when not explicitly given one in subsequent sync operations. |
| 487 | ** |
| 488 | ** Named remotes added by "remote add" allow use of those names in place |
| 489 | ** of a sync URL in any command that takes one. |
| 490 | ** |
| 491 | ** The full name of this command is "remote-url", but we anticipate no |
| 492 | ** future collision from use of its shortened form "remote". |
| 493 | ** |
| 494 | ** > fossil remote |
| 495 | ** |
| 496 | ** With no arguments, this command shows the current default remote |
| 497 | ** URL. If there is no default, it shows "off". |
| 498 | ** |
| 499 | ** > fossil remote add NAME URL |
| 500 | ** |
| 501 | ** Add a new named URL to the set of remote sync URLs for use in |
| 502 | ** place of a sync URL in commands that take one. |
| 503 | ** |
| 504 | ** > fossil remote delete NAME |
| 505 | ** |
| 506 | ** Delete a sync URL previously added by the "add" subcommand. |
| 507 | ** |
| 508 | ** > fossil remote list|ls |
| 509 | ** |
| 510 | ** Show all remote repository sync URLs. |
| 511 | ** |
| 512 | ** > fossil remote off |
| 513 | ** |
| 514 | ** Forget the default sync URL, disabling autosync. Combined with |
| 515 | ** named sync URLs, it allows canceling this "airplane mode" with |
| 516 | ** "fossil remote NAME" to select a previously-set named URL. |
| 517 | ** |
| 518 | ** To disable use of the default remote without forgetting its URL, |
| 519 | ** say "fossil set autosync 0" instead. |
| 520 | ** |
| 521 | ** > fossil remote scrub |
| 522 | ** |
| 523 | ** Forget any saved passwords for remote repositories, but continue |
| 524 | ** to remember the URLs themselves. You will be prompted for the |
| 525 |
| --- src/sync.c | |
| +++ src/sync.c | |
| @@ -470,55 +470,55 @@ | |
| 470 | ** COMMAND: remote |
| 471 | ** COMMAND: remote-url* |
| 472 | ** |
| 473 | ** Usage: %fossil remote ?SUBCOMMAND ...? |
| 474 | ** |
| 475 | ** View or modify the URLs of remote repositories used for syncing. |
| 476 | ** The "default" remote is the URL used in the most recent "sync", |
| 477 | ** "push", "pull", "clone", or similar command. The default remote can |
| 478 | ** change with each sync command. Other named remotes are persistent. |
| 479 | ** |
| 480 | ** > fossil remote |
| 481 | ** |
| 482 | ** With no arguments, this command shows the current default remote |
| 483 | ** URL. If there is no default, it shows "off". |
| 484 | ** |
| 485 | ** > fossil remote add NAME URL |
| 486 | ** |
| 487 | ** Add a new named URL. Afterwards, NAME can be used as a short |
| 488 | ** symbolic name for URL in contexts where a URL is required. The |
| 489 | ** URL argument can be "default" or a prior symbolic name, to make |
| 490 | ** a copy of an existing URL under a new name. |
| 491 | ** |
| 492 | ** > fossil config-data |
| 493 | ** |
| 494 | ** DEBUG USE ONLY - Show the name and value of every CONFIG table |
| 495 | ** entry in the repository that is associated with the remote URL store. |
| 496 | ** Passwords are obscured in the output. |
| 497 | ** |
| 498 | ** > fossil remote delete NAME |
| 499 | ** |
| 500 | ** Delete a named URL previously created by the "add" subcommand. |
| 501 | ** |
| 502 | ** > fossil remote list|ls |
| 503 | ** |
| 504 | ** Show all remote repository URLs. |
| 505 | ** |
| 506 | ** > fossil remote off |
| 507 | ** |
| 508 | ** Forget the default URL. This disables autosync. |
| 509 | ** |
| 510 | ** This is a convenient way to enter "airplane mode". To enter |
| 511 | ** airplane mode, first save the current default URL, then turn the |
| 512 | ** default off. Perhaps like this: |
| 513 | ** |
| 514 | ** fossil remote add main default |
| 515 | ** fossil remote off |
| 516 | ** |
| 517 | ** To exit airplane mode and turn autosync back on again: |
| 518 | ** |
| 519 | ** fossil remote main |
| 520 | ** |
| 521 | ** > fossil remote scrub |
| 522 | ** |
| 523 | ** Forget any saved passwords for remote repositories, but continue |
| 524 | ** to remember the URLs themselves. You will be prompted for the |
| 525 |