diff options
| author | Reid Kleckner <rnk@google.com> | 2017-03-24 20:47:41 +0000 |
|---|---|---|
| committer | Reid Kleckner <rnk@google.com> | 2017-03-24 20:47:41 +0000 |
| commit | 5c1500f417133193fb791e3d80abb07fc9ade699 (patch) | |
| tree | 584ee6301cc66b0a238bd66b626bde06d4292d74 | |
| parent | 64e872a91f217964dd899e2c8a4a6426f166a4dd (diff) | |
| download | bcm5719-llvm-5c1500f417133193fb791e3d80abb07fc9ade699.tar.gz bcm5719-llvm-5c1500f417133193fb791e3d80abb07fc9ade699.zip | |
Document how to fetch monorepo SVN revision notes
llvm-svn: 298733
| -rw-r--r-- | llvm/docs/GettingStarted.rst | 24 |
1 files changed, 18 insertions, 6 deletions
diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst index 6f8a4bb850f..d4ef89024fe 100644 --- a/llvm/docs/GettingStarted.rst +++ b/llvm/docs/GettingStarted.rst @@ -733,8 +733,8 @@ Or a combination of multiple projects: % mkdir clang-build && cd clang-build % cmake -GNinja ../llvm-project/llvm -DLLVM_ENABLE_PROJECTS="clang;libcxx;libcxxabi" -A helper script is provided in `llvm/utils/git-svn/git-llvm`. After you add it -to your path, you can push committed changes upstream with `git llvm push`. +A helper script is provided in ``llvm/utils/git-svn/git-llvm``. After you add it +to your path, you can push committed changes upstream with ``git llvm push``. .. code-block:: console @@ -743,10 +743,22 @@ to your path, you can push committed changes upstream with `git llvm push`. While this is using SVN under the hood, it does not require any interaction from you with git-svn. -After a few minutes, `git pull` should get back the changes as they were -committed. Note that a current limitation is that `git` does not directly record -file rename, and thus it is propagated to SVN as a combination of delete-add -instead of a file rename. +After a few minutes, ``git pull`` should get back the changes as they were +committed. Note that a current limitation is that ``git`` does not directly +record file rename, and thus it is propagated to SVN as a combination of +delete-add instead of a file rename. + +The SVN revision of each monorepo commit can be found in the commit notes. git +does not fetch notes by default. The following commands will fetch the notes and +configure git to fetch future notes. Use ``git notes show $commit`` to look up +the SVN revision of a git commit. The notes show up ``git log``, and searching +the log is currently the recommended way to look up the git commit for a given +SVN revision. + +.. code-block:: console + + % git config --add remote.origin.fetch +refs/notes/commits:refs/notes/commits + % git fetch If you are using `arc` to interact with Phabricator, you need to manually put it at the root of the checkout: |
