[llvm-commits] [lld] r155578 - in /lld/trunk/docs: development.rst getting_started.rst index.rst

[Michael Spencer]

On Thu, Apr 26, 2012 at 8:27 AM, Evandro Menezes
<emenezes at codeaurora.org> wrote:
> Indeed, I had to modify CMakeLists.txt in tools in order to build lld. See
> patch in attach.
>
> Perhaps the getting started notes should mention this.  If so, I'll gladly
> provide a patch for it.

Yep, I have a patch out for review that refactors how tools get included.

- Michael Spencer

> On 04/26/12 04:00, Jay Foad wrote:
>>
>> On 25 April 2012 20:34, Michael J. Spencer<bigcheesegs at gmail.com>  wrote:
>>>
>>> [docs] Add getting started guide.
>>
>>
>> Thanks for writing this up! A few nits below.
>>
>>> Added: lld/trunk/docs/getting_started.rst
>>> URL:
>>> http://llvm.org/viewvc/llvm-project/lld/trunk/docs/getting_started.rst?rev=155578&view=auto
>>>
>>> ==============================================================================
>>> --- lld/trunk/docs/getting_started.rst (added)
>>> +++ lld/trunk/docs/getting_started.rst Wed Apr 25 14:34:24 2012
>>> @@ -0,0 +1,99 @@
>>> +.. _getting_started:
>>> +
>>> +Getting Started: Building and Running lld
>>> +=========================================
>>> +
>>> +This page gives you the shortest path to checking out and building lld.
>>> If you
>>> +run into problems, please file bugs in the `LLVM Bugzilla`__
>>> +
>>> +__ http://llvm.org/bugs/
>>> +
>>> +Building lld
>>> +------------
>>> +
>>> +On Unix-like Systems
>>> +~~~~~~~~~~~~~~~~~~~~
>>> +
>>> +#. Get the required tools.
>>> +
>>> +  * `CMake 2.8`_\+.
>>> +  * make (or any build system CMake supports).
>>> +  * `Clang 3.1`_\+ or GCC 4.7+ (C++11 support is required).
>>> +
>>> +    * If using Clang, you will also need `libc++`_.
>>> +  * `Python 2.4`_\+ (not 3.x) for running tests.
>>> +
>>> +.. _CMake 2.8: http://www.cmake.org/cmake/resources/software.html
>>> +.. _Clang 3.1: http://clang.llvm.org/
>>> +.. _libc++: http://libcxx.llvm.org/
>>> +.. _Python 2.4: http://python.org/download/
>>> +
>>> +#. Check out LLVM::
>>
>>
>> The numbering for these "#." points seems to keep getting reset back
>> to 1. If I read this doc on the web
>> (http://lld.llvm.org/getting_started.html) the numbers go 1, 1, 2, 1,
>> 2 instead of 1, 2, 3, 4, 5.

Ah, thanks for letting me know.

>>> +
>>> +     $ cd path/to/llvm-project
>>> +     $ svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm
>>> +
>>> +#. Check out lld::
>>> +
>>> +     $ cd llvm/tools
>>> +     $ svn co http://llvm.org/svn/llvm-project/lld/trunk lld
>>
>>
>> It doesn't seem to work putting lld in tools/. Did you mean projects/
>> ? Or does LLVM's tools/CMakeLists.txt need updating to mention lld?
>>
>>> +
>>> +  * lld can also be checked out to ``path/to/llvm-project`` and built as
>>> an external
>>> +    project.
>>> +
>>> +#. Build LLVM and lld::
>>> +
>>> +     $ cd path/to/llvm-build/llvm (out of source build required)
>>> +     $ cmake -G "Unix Makefiles" path/to/llvm-project/llvm
>>> +     $ make
>>> +
>>> +#. Test::
>>> +
>>> +     $ make lld-test
>>
>>
>> I get:
>>
>> $ make lld-test
>> make: *** No rule to make target `lld-test'. Stop.
>>
>> but maybe that's because lld wasn't built (see above).
>>
>> Thanks,
>> Jay.