[PATCH] Document building and installing with CMake

[Tom Stellard]

On Wed, Feb 04, 2015 at 11:31:51PM +0100, Stephen Kelly wrote:
> 
> Hi there,
> 
> Please review and apply the attached patches.
> 
> Thanks!
> 
> Steve.

> From 26ec03a855c915bd5d0a9b159714980054deb02f Mon Sep 17 00:00:00 2001
> From: Stephen Kelly <steveire at gmail.com>
> Date: Wed, 4 Feb 2015 22:54:27 +0100
> Subject: [PATCH 1/2] Help: Document the minimum CMake version required.
> 
> ---
>  docs/CMake.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/docs/CMake.rst b/docs/CMake.rst
> index 47cb2f3..bfabb79 100644
> --- a/docs/CMake.rst
> +++ b/docs/CMake.rst
> @@ -26,7 +26,7 @@ Quick start
>  We use here the command-line, non-interactive CMake interface.
>  
>  #. `Download <http://www.cmake.org/cmake/resources/software.html>`_ and install
> -   CMake. Version 2.8 is the minimum required.
> +   CMake. Version 2.8.8 is the minimum required.
>  
>  #. Open a shell. Your development tools must be reachable from this shell
>     through the PATH environment variable.
> -- 
> 2.0.0.rc3.2.g998f840.dirty
> 

Patch 1: LGTM.

> 
> From f298f4b91dbab0931f105ca30c4324fd60c3abb9 Mon Sep 17 00:00:00 2001
> From: Stephen Kelly <steveire at gmail.com>
> Date: Wed, 4 Feb 2015 22:54:54 +0100
> Subject: [PATCH 2/2] Help: Document how to build and install with CMake.
> 
> Resolves PR21569.
> ---
>  docs/CMake.rst | 30 ++++++++++++++++++++++++++++++
>  1 file changed, 30 insertions(+)
> 
> diff --git a/docs/CMake.rst b/docs/CMake.rst
> index bfabb79..7de9102 100644
> --- a/docs/CMake.rst
> +++ b/docs/CMake.rst
> @@ -59,6 +59,36 @@ We use here the command-line, non-interactive CMake interface.
>     environment variable, for instance. You can force CMake to use a given build
>     tool, see the `Usage`_ section.
>  
> +#. After CMake has finished running, proceed to use IDE proect files or start

Spelling:                                                  project 

> +   the build from the build directory:
> +
> +   .. code-block:: console
> +
> +     $ cmake --build .
> +
> +   The ``--build`` option tells ``cmake`` to invoke the underlying build
> +   tool (``make``, ``ninja``, ``xcodebuild``, ``msbuild``, etc).
> +
> +   The underlying build tool can be invoked directly either of course, but
> +   the ``--build`` option is portable.
> +
> +#. After LLVM has finished building, install it from the build directory:
> +
> +   .. code-block:: console
> +
> +     $ cmake --build . --target install
> +
> +   The ``--target`` option with ``install`` parameter in addition to
> +   the ``--build`` option tells ``cmake`` to build the ``install`` target.
> +
> +   It is possible to set a different install prefix at installation time
> +   by invoking the ``cmake_install.cmake`` script generated in the
> +   build directory:
> +
> +   .. code-block:: console
> +
> +     $ cmake -DCMAKE_INSTALL_PREFIX=/tmp/llvm -P cmake_install.cmake
> +
>  .. _Basic CMake usage:
>  .. _Usage:
>  
> -- 
> 2.0.0.rc3.2.g998f840.dirty
> 

> _______________________________________________
> llvm-commits mailing list
> llvm-commits at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits