Add reference to dcommit on GettingStarted
authorRenato Golin <rengolin@systemcall.org>
Sun, 6 Jan 2013 00:14:27 +0000 (00:14 +0000)
committerRenato Golin <rengolin@systemcall.org>
Sun, 6 Jan 2013 00:14:27 +0000 (00:14 +0000)
Signed-off-by: Renato Golin <renato.golin@linaro.org>
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@171642 91177308-0d34-0410-b5e6-96231b3b80d8

docs/GettingStarted.rst

index 3605686f161bd1206db51dabca5bc4b2a0a4ab17..443d21f04ac167ee10e86cacd186449db9f26148 100644 (file)
@@ -633,8 +633,21 @@ upstream git repo, run:
 
 This leaves your working directories on their master branches, so you'll need to
 ``checkout`` each working branch individually and ``rebase`` it on top of its
-parent branch.  (Note: This script is intended for relative newbies to git.  If
-you have more experience, you can likely improve on it.)
+parent branch.
+
+To commit back changes via git-svn, use ``dcommit``:
+
+.. code-block:: console
+
+  % git svn dcommit
+
+Note that git-svn will create one SVN commit for each Git commit you have pending,
+so squash and edit each commit before executing ``dcommit`` to make sure they all
+conform to the coding standards and the developers' policy.
+
+On success, ``dcommit`` will rebase against the HEAD of SVN, so to avoid conflict,
+please make sure your current branch is up-to-date (via fetch/rebase) before
+proceeding.
 
 The git-svn metadata can get out of sync after you mess around with branches and
 ``dcommit``. When that happens, ``git svn dcommit`` stops working, complaining
@@ -645,6 +658,8 @@ about files with uncommitted changes. The fix is to rebuild the metadata:
   % rm -rf .git/svn
   % git svn rebase -l
 
+Please, refer to the Git-SVN manual (``man git-svn``) for more information.
+
 Local LLVM Configuration
 ------------------------