[PATCH 3/4] Add doc for 'clone' and 'init'.

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 





Signed-off-by: Yann Dirson <ydirson@xxxxxxxxxx>
---

 Documentation/stg-clone.txt |   36 ++++++++++++++++++++++++++++++++++++
 Documentation/stg-init.txt  |   33 +++++++++++++++++++++++++++++++++
 2 files changed, 69 insertions(+), 0 deletions(-)

diff --git a/Documentation/stg-clone.txt b/Documentation/stg-clone.txt
new file mode 100644
index 0000000..73c0d92
--- /dev/null
+++ b/Documentation/stg-clone.txt
@@ -0,0 +1,36 @@
+stg-clone(1)
+==========
+Yann Dirson <ydirson@xxxxxxxxxx>
+v0.12.1, April 2007
+
+NAME
+----
+stg-clone - stgdesc:clone[]
+
+SYNOPSIS
+--------
+stg clone [OPTIONS] <repository> <dir>
+
+DESCRIPTION
+-----------
+
+Clone a GIT <repository> into the local <dir> (using
+gitlink:git-clone[1]) and initialise the resulting "master" branch as
+a patch stack.
+
+This operation is for example suitable to start working using the
+"tracking branch" workflow (see gitlink:stg[1]).  Other means to setup
+an StGIT stack are stgdesc:init[] and the '--create' and '--clone'
+commands of stgdesc:branch[].
+
+The target directory named by <dir> will be created by this command,
+and must not exist beforehand.
+
+OPTIONS
+-------
+
+No specific options.
+
+StGIT
+-----
+Part of the StGIT suite - see gitlink:stg[1].
diff --git a/Documentation/stg-init.txt b/Documentation/stg-init.txt
new file mode 100644
index 0000000..33fd387
--- /dev/null
+++ b/Documentation/stg-init.txt
@@ -0,0 +1,33 @@
+stg-init(1)
+==========
+Yann Dirson <ydirson@xxxxxxxxxx>
+v0.12.1, April 2007
+
+NAME
+----
+stg-init - stgdesc:init[]
+
+SYNOPSIS
+--------
+stg init [OPTIONS]
+
+DESCRIPTION
+-----------
+
+Initialise the current GIT branch to be used as an StGIT stack.  You
+must already be in a GIT repository and .git/HEAD must point to a
+valid file in refs/heads/.
+
+This operation is for example suitable to start working using the
+"development branch" workflow (see gitlink:stg[1]).  Other means to setup
+an StGIT stack are stgdesc:clone[] and the '--create' and '--clone'
+commands of stgdesc:branch[].
+
+OPTIONS
+-------
+
+No specific options.
+
+StGIT
+-----
+Part of the StGIT suite - see gitlink:stg[1].

-
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]