diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst --- a/llvm/docs/GettingStarted.rst +++ b/llvm/docs/GettingStarted.rst @@ -160,9 +160,9 @@ Software -------- -Compiling LLVM requires that you have several software packages installed. The -table below lists those required packages. The Package column is the usual name -for the software package that LLVM depends on. The Version column provides +Working with LLVM requires that you have several software packages installed. +The table below lists those required packages. The Package column is the usual +name for the software package that LLVM depends on. The Version column provides "known to work" versions of the package. The Notes column describes how LLVM uses the package and provides other details. @@ -503,8 +503,8 @@ 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``. While this creates a Subversion checkout and patches it under the hood, -it does not require you to have interaction with it. +push``\ :sup:`1`. While this creates a Subversion checkout and patches it under +the hood, it does not require you to have interaction with it. .. code-block:: console @@ -525,6 +525,10 @@ tell you what it would have done. That can be useful if you're unsure whether the right thing will happen. +.. note:: + + #. The helper script works with git versions >=2.9.3 + Reverting a change when using Git ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^