1STG-BRANCH(1)                    StGit Manual                    STG-BRANCH(1)
2
3
4

NAME

6       stg-branch - Branch operations: switch, list, create, rename, delete,
7       ...
8

SYNOPSIS

10       stg branch
11       stg branch [--merge] [--] <branch>
12       stg branch --list
13       stg branch --create [--] <new-branch> [<committish>]
14       stg branch --clone [--] [<new-branch>]
15       stg branch --rename [--] <old-name> <new-name>
16       stg branch --protect [--] [<branch>]
17       stg branch --unprotect [--] [<branch>]
18       stg branch --delete [--force] [--] <branch>
19       stg branch --cleanup [--force] [--] [<branch>]
20       stg branch --description=<description> [--] [<branch>]
21

DESCRIPTION

23       Create, clone, switch between, rename, or delete development branches
24       within a git repository.
25
26
27       stg branch
28           Display the name of the current branch.
29
30       stg branch <branch>
31           Switch to the given branch.
32

OPTIONS

34       -l, --list
35           List each branch in the current repository, followed by its branch
36           description (if any). The current branch is prefixed with >.
37           Branches that have been initialized for StGit (with stg-init(1))
38           are prefixed with s. Protected branches are prefixed with p.
39
40       -c, --create
41           Create (and switch to) a new branch. The new branch is already
42           initialized as an StGit patch stack, so you do not have to run stg-
43           init(1) manually. If you give a committish argument, the new branch
44           is based there; otherwise, it is based at the current HEAD.
45
46           StGit will try to detect the branch off of which the new branch is
47           forked, as well as the remote repository from which that parent
48           branch is taken (if any), so that running stg-pull(1) will
49           automatically pull new commits from the correct branch. It will
50           warn if it cannot guess the parent branch (e.g. if you do not
51           specify a branch name as committish).
52
53       --clone
54           Clone the current branch, under the name <new-branch> if specified,
55           or using the current branch’s name plus a timestamp.
56
57           The description of the new branch is set to tell it is a clone of
58           the current branch. The parent information of the new branch is
59           copied from the current branch.
60
61       -r, --rename
62           Rename an existing branch.
63
64       -p, --protect
65           Prevent StGit from modifying a branch — either the current one, or
66           one named on the command line.
67
68       -u, --unprotect
69           Allow StGit to modify a branch — either the current one, or one
70           named on the command line. This undoes the effect of an earlier stg
71           branch --protect command.
72
73       --delete
74           Delete the named branch. If there are any patches left in the
75           branch, StGit will refuse to delete it unless you give the --force
76           flag.
77
78           A protected branch cannot be deleted; it must be unprotected first
79           (see --unprotect above).
80
81           If you delete the current branch, you are switched to the "master"
82           branch, if it exists.
83
84       --cleanup
85           Remove the StGit information for the current or given branch. If
86           there are patches left in the branch, StGit refuses the operation
87           unless --force is given.
88
89           A protected branch cannot be cleaned up; it must be unprotected
90           first (see --unprotect above).
91
92           A cleaned up branch can be re-initialised using the stg init
93           command.
94
95       -d DESCRIPTION, --description DESCRIPTION
96           Set the branch description.
97
98       --merge
99           Merge work tree changes into the other branch.
100
101       --force
102           Force a delete when the series is not empty.
103

STGIT

105       Part of the StGit suite - see stg(1)
106
107
108
109
110StGit                             02/03/2019                     STG-BRANCH(1)
Impressum