Fossil SCM

Update the help text for "fossil branch new" to make it clear that the preferred idiom for branch creation in Fossil is to use the --branch option on the "fossil commit" command.

drh 2025-03-30 18:40 trunk
Commit 1869b58580bc8ebcb8b2cab0030e2e18f5009500a288a592591733c90ff3e7a4
1 file changed +6 -6
+6 -6
--- src/branch.c
+++ src/branch.c
@@ -657,25 +657,25 @@
657657
**
658658
** > fossil branch new BRANCH-NAME BASIS ?OPTIONS?
659659
**
660660
** Create a new branch BRANCH-NAME off of check-in BASIS.
661661
**
662
+** This command is available for people who want to create a branch
663
+** in advance. But the use of this command is discouraged. The
664
+** preferred idiom in Fossil is to create new branches at the point
665
+** of need, using the "--branch NAME" option to the "fossil commit"
666
+** command.
667
+**
662668
** Options:
663669
** --private Branch is private (i.e., remains local)
664670
** --bgcolor COLOR Use COLOR instead of automatic background
665671
** --nosign Do not sign the manifest for the check-in
666672
** that creates this branch
667673
** --nosync Do not auto-sync prior to creating the branch
668674
** --date-override DATE DATE to use instead of 'now'
669675
** --user-override USER USER to use instead of the current default
670676
**
671
-** DATE may be "now" or "YYYY-MM-DDTHH:MM:SS.SSS". If in
672
-** year-month-day form, it may be truncated, the "T" may be
673
-** replaced by a space, and it may also name a timezone offset
674
-** from UTC as "-HH:MM" (westward) or "+HH:MM" (eastward).
675
-** Either no timezone suffix or "Z" means UTC.
676
-**
677677
** Options:
678678
** -R|--repository REPO Run commands on repository REPO
679679
*/
680680
void branch_cmd(void){
681681
int n;
682682
--- src/branch.c
+++ src/branch.c
@@ -657,25 +657,25 @@
657 **
658 ** > fossil branch new BRANCH-NAME BASIS ?OPTIONS?
659 **
660 ** Create a new branch BRANCH-NAME off of check-in BASIS.
661 **
 
 
 
 
 
 
662 ** Options:
663 ** --private Branch is private (i.e., remains local)
664 ** --bgcolor COLOR Use COLOR instead of automatic background
665 ** --nosign Do not sign the manifest for the check-in
666 ** that creates this branch
667 ** --nosync Do not auto-sync prior to creating the branch
668 ** --date-override DATE DATE to use instead of 'now'
669 ** --user-override USER USER to use instead of the current default
670 **
671 ** DATE may be "now" or "YYYY-MM-DDTHH:MM:SS.SSS". If in
672 ** year-month-day form, it may be truncated, the "T" may be
673 ** replaced by a space, and it may also name a timezone offset
674 ** from UTC as "-HH:MM" (westward) or "+HH:MM" (eastward).
675 ** Either no timezone suffix or "Z" means UTC.
676 **
677 ** Options:
678 ** -R|--repository REPO Run commands on repository REPO
679 */
680 void branch_cmd(void){
681 int n;
682
--- src/branch.c
+++ src/branch.c
@@ -657,25 +657,25 @@
657 **
658 ** > fossil branch new BRANCH-NAME BASIS ?OPTIONS?
659 **
660 ** Create a new branch BRANCH-NAME off of check-in BASIS.
661 **
662 ** This command is available for people who want to create a branch
663 ** in advance. But the use of this command is discouraged. The
664 ** preferred idiom in Fossil is to create new branches at the point
665 ** of need, using the "--branch NAME" option to the "fossil commit"
666 ** command.
667 **
668 ** Options:
669 ** --private Branch is private (i.e., remains local)
670 ** --bgcolor COLOR Use COLOR instead of automatic background
671 ** --nosign Do not sign the manifest for the check-in
672 ** that creates this branch
673 ** --nosync Do not auto-sync prior to creating the branch
674 ** --date-override DATE DATE to use instead of 'now'
675 ** --user-override USER USER to use instead of the current default
676 **
 
 
 
 
 
 
677 ** Options:
678 ** -R|--repository REPO Run commands on repository REPO
679 */
680 void branch_cmd(void){
681 int n;
682

Keyboard Shortcuts

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