[llvm-bugs] [Bug 25371] New: Kaleidoscope Tutorial Ch2 falsely claims that it doesn't depend on LLVM

via llvm-bugs llvm-bugs at lists.llvm.org
Sun Nov 1 14:32:40 PST 2015


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

            Bug ID: 25371
           Summary: Kaleidoscope Tutorial Ch2 falsely claims that it
                    doesn't depend on LLVM
           Product: Documentation
           Version: trunk
          Hardware: PC
                OS: All
            Status: NEW
          Severity: normal
          Priority: P
         Component: General docs
          Assignee: unassignedbugs at nondot.org
          Reporter: modocache at gmail.com
                CC: llvm-bugs at lists.llvm.org
    Classification: Unclassified

The documentation in `docs/tutorial/LangImpl2.rst` states of the example code:
"Note that it is fully self-contained: you don’t need LLVM or any external
libraries at all for this." It proceeds to claim the example code can be
compiled with `clang++ -g -O3 toy.cpp`, which is not true.

The problem is that the example code imports `llvm/ADT/STLExtras.h` and uses
`llvm::make_unique`.

Two possible solutions:

1. Remove the claim and show a compile command that will actually work with the
LLVM import.
2. Remove references to `llvm::make_unique`, and actually have the code compile
with a simple `clang++ -g -O3 toy.cpp`.

I think #2 is the way to go, since readers new to LLVM won't immediately know
what `llvm::make_unique` does anyway--best to stick to stdlib.

-- 
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/20151101/2f4f2ada/attachment.html>


More information about the llvm-bugs mailing list