[docs] Tweak the example to match what is apparantly the desired form
[oota-llvm.git] / docs / GettingStarted.rst
index b47c6ebb0a3447823f7604a2c2f3e2530d028177..780f105e75f7a07702d737ed2c7f9ae2cef3006c 100644 (file)
@@ -182,7 +182,7 @@ Package                                                     Version      Notes
    #. If you want to make changes to the configure scripts, you will need GNU
       autoconf (2.60), and consequently, GNU M4 (version 1.4 or higher). You
       will also need automake (1.9.6). We only use aclocal from that package.
-   #. Optional, adds compression/uncompression capabilities to selected LLVM
+#.Optional, adds compression / uncompression capabilities to selected LLVM
       tools.
 
 Additionally, your compilation host is expected to have the usual plethora of
@@ -278,11 +278,11 @@ of writing, this breaks LLD build.
 Getting a Modern Host C++ Toolchain
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-This section mostly applies to Linux and older BSDs. On Mac OS X, you should have
-a sufficiently modern Xcode, or you will likely need to upgrade until you do.
-On Windows, just use Visual Studio 2012 as the host compiler, it is explicitly
-supported and widely available. FreeBSD 10.0 and newer have a modern Clang as
-the system compiler.
+This section mostly applies to Linux and older BSDs. On Mac OS X, you should
+have a sufficiently modern Xcode, or you will likely need to upgrade until you
+do. On Windows, just use Visual Studio 2012 as the host compiler, it is
+explicitly supported and widely available. FreeBSD 10.0 and newer have a modern
+Clang as the system compiler.
 
 However, some Linux distributions and some other or older BSDs sometimes have
 extremely old versions of GCC. These steps attempt to help you upgrade you
@@ -297,34 +297,38 @@ initial host in a bootstrap, and then using Clang (and potentially libc++).
 The first step is to get a recent GCC toolchain installed. The most common
 distribution on which users have struggled with the version requirements is
 Ubuntu Precise, 12.04 LTS. For this distribution, one easy option is to install
-the `toolchain testing PPA
-<https://launchpad.net/~ubuntu-toolchain-r/+archive/test>` and use it to
-install a modern GCC. There is a really nice discussions of this on the `ask
-ubuntu stack exchange
-<http://askubuntu.com/questions/271388/how-to-install-gcc-4-8-in-ubuntu-12-04-from-the-terminal>`.
-However, not all users can use PPAs and there are many other distros, so it may
-be necessory (or just useful, if you're here you *are* doing compiler
-development after all) to build and install GCC from source. It is also quite
-easy to do these days.
+the `toolchain testing PPA`_ and use it to install a modern GCC. There is
+a really nice discussions of this on the `ask ubuntu stack exchange`_. However,
+not all users can use PPAs and there are many other distributions, so it may be
+necessary (or just useful, if you're here you *are* doing compiler development
+after all) to build and install GCC from source. It is also quite easy to do
+these days.
+
+.. _toolchain testing PPA:
+  https://launchpad.net/~ubuntu-toolchain-r/+archive/test
+.. _ask ubuntu stack exchange:
+  http://askubuntu.com/questions/271388/how-to-install-gcc-4-8-in-ubuntu-12-04-from-the-terminal
 
 Easy steps for installing GCC 4.8.2:
 
 .. code-block:: console
 
-  wget ftp://ftp.gnu.org/gnu/gcc/gcc-4.8.2/gcc-4.8.2.tar.bz2
-  tar -xvjf gcc-4.8.2.tar.bz2
-  cd gcc-4.8.2
-  ./contrib/download_prerequisites
-  cd ..
-  mkdir gcc-4.8.2-build
-  cd gcc-4.8.2-build
-  %PWD/../gcc-4.8.2/configure --prefix=$HOME/toolchains --enable-languages=c,c++
-  make -j$(nproc)
-  make install
-
-For more details, check out the `excellent GCC wiki entry
-<http://gcc.gnu.org/wiki/InstallingGCC>`, where I got most of this information
-from.
+  % wget ftp://ftp.gnu.org/gnu/gcc/gcc-4.8.2/gcc-4.8.2.tar.bz2
+  % tar -xvjf gcc-4.8.2.tar.bz2
+  % cd gcc-4.8.2
+  % ./contrib/download_prerequisites
+  % cd ..
+  % mkdir gcc-4.8.2-build
+  % cd gcc-4.8.2-build
+  % $PWD/../gcc-4.8.2/configure --prefix=$HOME/toolchains --enable-languages=c,c++
+  % make -j$(nproc)
+  % make install
+
+For more details, check out the excellent `GCC wiki entry`_, where I got most
+of this information from.
+
+.. _GCC wiki entry:
+  http://gcc.gnu.org/wiki/InstallingGCC
 
 Once you have a GCC toolchain, use it as your host compiler. Things should
 generally "just work". You may need to pass a special linker flag,
@@ -556,9 +560,8 @@ Then, your .git/config should have [imap] sections.
         pass = himitsu!
         port = 993
         sslverify = false
-  ; in English
-        folder = "[Gmail]/Drafts"
-  ; example for Japanese, "Modified UTF-7" encoded.
+  ;
+in English folder = "[Gmail]/Drafts"; example for Japanese, "Modified UTF-7" encoded.
         folder = "[Gmail]/&Tgtm+DBN-"
   ; example for Traditional Chinese
         folder = "[Gmail]/&g0l6Pw-"