git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Yann Dirson <ydirson@altern.org>
To: Catalin Marinas <catalin.marinas@gmail.com>
Cc: git@vger.kernel.org
Subject: [PATCH 4/4] Add doc for 'branch'.
Date: Sat, 07 Apr 2007 23:37:08 +0200	[thread overview]
Message-ID: <20070407213708.13698.28332.stgit@gandelf.nowhere.earth> (raw)
In-Reply-To: <20070407213557.13698.21486.stgit@gandelf.nowhere.earth>




Signed-off-by: Yann Dirson <ydirson@altern.org>
---

 Documentation/stg-branch.txt |  127 ++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 127 insertions(+), 0 deletions(-)

diff --git a/Documentation/stg-branch.txt b/Documentation/stg-branch.txt
new file mode 100644
index 0000000..53f333b
--- /dev/null
+++ b/Documentation/stg-branch.txt
@@ -0,0 +1,127 @@
+stg-branch(1)
+=============
+Yann Dirson <ydirson@altern.org>
+v0.12.1, April 2007
+
+NAME
+----
+stg-branch - stgdesc:branch[]
+
+SYNOPSIS
+--------
+stg branch
+
+stg branch <branch>
+
+stg branch --list
+
+stg branch --create <newstack> [<commit-id>]
+
+stg branch --clone [<newstack>]
+
+stg branch --rename <oldname> <newname>
+
+stg branch --protect [<branch>]
+
+stg branch --unprotect [<branch>]
+
+stg branch --delete [--force] <branch>
+
+stg branch --convert
+
+DESCRIPTION
+-----------
+
+Assorted operations on branches.
+
+no command, no argument::
+	Display the name of the current branch.
+
+no command, one argument::
+	Switch to the named <branch>.
+
+--list::
+-l::
+	Display the list of branches in the current repository,
+	suffixed by the branch description if any, and optionally
+	prefixed by the letter flags 's' if the branch is an StGIT
+	stack, and 'p' if the StGIT stack is protected.  The current
+	branch is shown with a leading ">" character.
+
+--create::
+-c::
+	Create a new StGIT stack based at the specified commit, or at
+	the current HEAD if not specified.  The repository HEAD is
+	switched to the new stack.
++
+StGIT will try to detect the branch off which the new stack is forked,
+as well as the remote repository from which that parent branch is
+taken (if any), so running stgdesc:pull[] will effectively pull new
+commits from the correct branch.  It will warn if it cannot guess the
+parent branch (eg. if you do not specify a branch name as
+<commit-id>).
+
+--clone::
+	Clone the current stack, under the name <newstack> if
+	specified, or using the current stack's name suffixed by a
+	timestamp.
++
+The description of the new stack is set to tell it is a clone of the
+current stack.  The parent information of the new stack is copied from
+the current stack.
++
+Cloning a GIT branch that is not an StGIT stack is similar to creating
+a new stack off the current branch.
+
+--rename::
+-r::
+	Rename the stack named <oldname> to <newname>.
+
+--protect::
+-p::
+	Protect the named stack or the current one, preventing
+	further StGIT operations from modifying this stack.
+
+--unprotect::
+-u::
+	Remove a "protected" flag previously set with '--protect'.
+
+--delete::
+	Delete the named <branch>.  If there are any patches left in
+	the series, StGIT will refuse to delete it, unless '--force'
+	is specified.
++
+A protected branch cannot be deleted, it must be unprotected first
+(see above).
++
+When the current branch is deleted, the repository HEAD is switched to
+the "master" branch if it exists.
++
+Branch "master" is treated specially (see bug #8732), in that only the
+StGIT metadata are removed, the GIT branch itself is not destroyed.
+
+--convert::
+	Switch current stack between old and new format.
+
+OPTIONS
+-------
+
+--force::
+	Force a delete when the series is not empty.
+
+FILES
+-----
+
+	$GIT_DIR/patches/<branch>/description
+	$GIT_DIR/patches/<branch>/protected
+
+GIT CONFIGURATION VARIABLES
+---------------------------
+
+	branch.<branchname>.remote
+	branch.<branchname>.merge
+	branch.<branchname>.stgit.parentbranch
+
+StGIT
+-----
+Part of the StGIT suite - see gitlink:stg[1].

      parent reply	other threads:[~2007-04-07 21:37 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-04-07 21:36 [PATCH 0/4] StGIT documentation updates Yann Dirson
2007-04-07 21:36 ` [PATCH 1/4] Fix typo in help string Yann Dirson
2007-04-07 21:36 ` [PATCH 2/4] Don't use section 7 for main manpage Yann Dirson
2007-04-11  9:34   ` Catalin Marinas
2007-04-07 21:37 ` [PATCH 3/4] Add doc for 'clone' and 'init' Yann Dirson
2007-04-07 21:37 ` Yann Dirson [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20070407213708.13698.28332.stgit@gandelf.nowhere.earth \
    --to=ydirson@altern.org \
    --cc=catalin.marinas@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).