RPCSX/llvm
1
0
Fork 0
mirror of https://github.com/RPCSX/llvm.git synced 2024-11-25 12:50:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs/GettingStarted.rst: Whitespace only

Browse Source 
From: Erik de Castro Lopo <erikd@qti.qualcomm.com>

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@243916 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Mehdi Amini 2015-08-03 23:17:44 +00:00
parent 3db44ce9a8
commit 5d9068c949
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/GettingStarted.rst
View File

@ -1,5 +1,5 @@
==================================== ====================================
Getting Started with the LLVM System Getting Started with the LLVM System
==================================== ====================================
.. contents:: .. contents::
@ -62,7 +62,7 @@ Here's the short story for getting up and running quickly with LLVM:
* ``svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite`` * ``svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite``
#. Configure and build LLVM and Clang: #. Configure and build LLVM and Clang:
The usual build uses `CMake <CMake.html>`_. If you would rather use The usual build uses `CMake <CMake.html>`_. If you would rather use
autotools, see `Building LLVM with autotools <BuildingLLVMWithAutotools.html>`_. autotools, see `Building LLVM with autotools <BuildingLLVMWithAutotools.html>`_.
@ -70,7 +70,7 @@ Here's the short story for getting up and running quickly with LLVM:
* ``mkdir build`` * ``mkdir build``
* ``cd build`` * ``cd build``
* ``cmake -G <generator> [options] <path to llvm sources>`` * ``cmake -G <generator> [options] <path to llvm sources>``
Some common generators are: Some common generators are:
* ``Unix Makefiles`` --- for generating make-compatible parallel makefiles. * ``Unix Makefiles`` --- for generating make-compatible parallel makefiles.
@ -79,7 +79,7 @@ Here's the short story for getting up and running quickly with LLVM:
* ``Visual Studio`` --- for generating Visual Studio projects and * ``Visual Studio`` --- for generating Visual Studio projects and
solutions. solutions.
* ``Xcode`` --- for generating Xcode projects. * ``Xcode`` --- for generating Xcode projects.
Some Common options: Some Common options:
* ``-DCMAKE_INSTALL_PREFIX=directory`` --- Specify for *directory* the full * ``-DCMAKE_INSTALL_PREFIX=directory`` --- Specify for *directory* the full
@ -125,20 +125,20 @@ Hardware
LLVM is known to work on the following host platforms: LLVM is known to work on the following host platforms:
================== ===================== ============= ================== ===================== =============
OS Arch Compilers OS Arch Compilers
================== ===================== ============= ================== ===================== =============
Linux x86\ :sup:`1` GCC, Clang Linux x86\ :sup:`1` GCC, Clang
Linux amd64 GCC, Clang Linux amd64 GCC, Clang
Linux ARM\ :sup:`4` GCC, Clang Linux ARM\ :sup:`4` GCC, Clang
Linux PowerPC GCC, Clang Linux PowerPC GCC, Clang
Solaris V9 (Ultrasparc) GCC Solaris V9 (Ultrasparc) GCC
FreeBSD x86\ :sup:`1` GCC, Clang FreeBSD x86\ :sup:`1` GCC, Clang
FreeBSD amd64 GCC, Clang FreeBSD amd64 GCC, Clang
MacOS X\ :sup:`2` PowerPC GCC MacOS X\ :sup:`2` PowerPC GCC
MacOS X x86 GCC, Clang MacOS X x86 GCC, Clang
Cygwin/Win32 x86\ :sup:`1, 3` GCC Cygwin/Win32 x86\ :sup:`1, 3` GCC
Windows x86\ :sup:`1` Visual Studio Windows x86\ :sup:`1` Visual Studio
Windows x64 x86-64 Visual Studio Windows x64 x86-64 Visual Studio
================== ===================== ============= ================== ===================== =============
.. note:: .. note::
@ -207,14 +207,14 @@ Unix utilities. Specifically:
* **chmod** --- change permissions on a file * **chmod** --- change permissions on a file
* **cat** --- output concatenation utility * **cat** --- output concatenation utility
* **cp** --- copy files * **cp** --- copy files
* **date** --- print the current date/time * **date** --- print the current date/time
* **echo** --- print to standard output * **echo** --- print to standard output
* **egrep** --- extended regular expression search utility * **egrep** --- extended regular expression search utility
* **find** --- find files/dirs in a file system * **find** --- find files/dirs in a file system
* **grep** --- regular expression search utility * **grep** --- regular expression search utility
* **gzip** --- gzip command for distribution generation * **gzip** --- gzip command for distribution generation
* **gunzip** --- gunzip command for distribution checking * **gunzip** --- gunzip command for distribution checking
* **install** --- install directories/files * **install** --- install directories/files
* **mkdir** --- create a directory * **mkdir** --- create a directory
* **mv** --- move (rename) files * **mv** --- move (rename) files
* **ranlib** --- symbol table builder for archive libraries * **ranlib** --- symbol table builder for archive libraries
@ -881,7 +881,7 @@ Underneath that directory there is another directory with a name ending in
For example: For example:
.. code-block:: console .. code-block:: console
% cd llvm_build_dir % cd llvm_build_dir
% find lib/Support/ -name APFloat* % find lib/Support/ -name APFloat*
lib/Support/CMakeFiles/LLVMSupport.dir/APFloat.cpp.o lib/Support/CMakeFiles/LLVMSupport.dir/APFloat.cpp.o
@ -990,7 +990,7 @@ different `tools`_.
code generation. For example, the ``llvm/lib/Target/X86`` directory holds the code generation. For example, the ``llvm/lib/Target/X86`` directory holds the
X86 machine description while ``llvm/lib/Target/ARM`` implements the ARM X86 machine description while ``llvm/lib/Target/ARM`` implements the ARM
backend. backend.
``llvm/lib/CodeGen/`` ``llvm/lib/CodeGen/``
This directory contains the major parts of the code generator: Instruction This directory contains the major parts of the code generator: Instruction
@ -1075,7 +1075,7 @@ the `Command Guide <CommandGuide/index.html>`_.
The archiver produces an archive containing the given LLVM bitcode files, The archiver produces an archive containing the given LLVM bitcode files,
optionally with an index for faster lookup. optionally with an index for faster lookup.
``llvm-as`` ``llvm-as``
The assembler transforms the human readable LLVM assembly to LLVM bitcode. The assembler transforms the human readable LLVM assembly to LLVM bitcode.
@ -1088,7 +1088,7 @@ the `Command Guide <CommandGuide/index.html>`_.
``llvm-link``, not surprisingly, links multiple LLVM modules into a single ``llvm-link``, not surprisingly, links multiple LLVM modules into a single
program. program.
``lli`` ``lli``
``lli`` is the LLVM interpreter, which can directly execute LLVM bitcode ``lli`` is the LLVM interpreter, which can directly execute LLVM bitcode
@ -1219,7 +1219,7 @@ Example with clang
.. code-block:: console .. code-block:: console
% ./hello % ./hello
and and
.. code-block:: console .. code-block:: console