[LLVMbugs] [Bug 13866] New: LLVM Makefile Guide - Incorrect Information & Typos

bugzilla-daemon at llvm.org bugzilla-daemon at llvm.org
Tue Sep 18 09:34:39 PDT 2012


             Bug #: 13866
           Summary: LLVM Makefile Guide - Incorrect Information & Typos
           Product: Documentation
           Version: trunk
          Platform: PC
        OS/Version: All
            Status: NEW
          Severity: enhancement
          Priority: P
         Component: General docs
        AssignedTo: unassignedbugs at nondot.org
        ReportedBy: jvilk at cs.umass.edu
                CC: llvmbugs at cs.uiuc.edu
    Classification: Unclassified

I'm reading through the LLVM Makefile guide, and I've noticed a few simple


"Note that setting this variable without also setting SHARED_LIBRARY will have
no effect."

This is a lie. In practice, setting LOADABLE_MODULE without SHARED_LIBRARY will
build a loadable shared library. In addition, the example in the documentation
at the following link sets LOADABLE_MODULE without setting SHARED_LIBRARY:

One also doesn't need to look far to find an example in the LLVM codebase
itself, e.g.

"Specify a set of directories that may be built, if they exist, but its (sic)
not an error for them not to exist."


"Note that two different variables are use (sic) to indicate which libraries
are linked: USEDLIBS and LLVMLIBS."

In addition to the typo, the example above this statement only uses USEDLIBS
and LINK_COMPONENTS. LLVMLIBS is nowhere to be found in the example; the
example uses LINK_COMPONENTS. It's possible this is not a bug and was intended,
but it seemed a bit odd to me.


"These variables enable rules and processing in the makefile system that
automatically Do The Right Thing™."

"™" does not appear as a trademark symbol. The ampersand is escaped in
the HTML code (as &). My guess is the documentation system is automatically
doing this.


There's a stray line break on the first item in the ordered list.


"The LLVM project itself uses dejagnu to run a suite of feature and regresson
(sic) tests."


"The cleaning rules have been made guarded so they shouldn’t go awry (via rm -f
$(UNSET_VARIABLE)/* which will attempt to erase the entire directory

Not sure what's going on with the "/*". I'm pretty sure that should be a close


Configure bugmail: http://llvm.org/bugs/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.

More information about the llvm-bugs mailing list