[LLVMbugs] [Bug 23128] New: Instructions for obtaining clang in the LibTooling and LibASTMatchers tutorial are confusing and out of date

[bugzilla-daemon at llvm.org]

https://llvm.org/bugs/show_bug.cgi?id=23128

            Bug ID: 23128
           Summary: Instructions for obtaining clang in the LibTooling and
                    LibASTMatchers tutorial are confusing and out of date
           Product: clang
           Version: trunk
          Hardware: PC
                OS: All
            Status: NEW
          Severity: normal
          Priority: P
         Component: Documentation
          Assignee: unassignedclangbugs at nondot.org
          Reporter: llvm-bugs at justinbogner.com
                CC: llvmbugs at cs.uiuc.edu
    Classification: Unclassified

The tutorial at http://clang.llvm.org/docs/LibASTMatchersTutorial.html begins
with instructions on obtaining clang. 

In these instructions, the user is told to configure with "cmake -G Ninja
../llvm -DLLVM_BUILD_TESTS=ON", then install this compiler and use it to
bootstrap clang. There are a couple of problems here:

1. Most distributions have clang packages these days, so if we really just need
the user to use a clang host compiler we should probably say that, rather than
explaining how to bootstrap.

1a. Do we even need clang as a host compiler? Any compiler that can build llvm
and clang should be fine, shouldn't it?

2. This builds clang without any optimizations, making the rest of the steps of
the tutorial *horribly slow*. At least set CMAKE_BUILD_TYPE=Release.

3. What's up with mentioning LLVM_BUILD_TESTS? It's not necessary for anything
in this tutorial, and the check targets build the tests regardless.

It's also kind of dated that we explain how to build make and ninja and claim
that you should build them yourself because current cmake doesn't support
ninja. That hasn't been true for quite a while.

-- 
You are receiving this mail because:
You are on the CC list for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-bugs/attachments/20150405/67d1d5d1/attachment.html>