Skip to content

Commit

Permalink
Sphinxify the outdated Packaging documentation.
Browse files Browse the repository at this point in the history
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@158901 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
isanbard committed Jun 21, 2012
1 parent 8ef0968 commit 1d4e628
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 120 deletions.
119 changes: 0 additions & 119 deletions docs/Packaging.html

This file was deleted.

75 changes: 75 additions & 0 deletions docs/Packaging.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
.. _packaging:

========================
Advice on Packaging LLVM
========================

.. contents::
:local:

Overview
========

LLVM sets certain default configure options to make sure our developers don't
break things for constrained platforms. These settings are not optimal for most
desktop systems, and we hope that packagers (e.g., Redhat, Debian, MacPorts,
etc.) will tweak them. This document lists settings we suggest you tweak.

LLVM's API changes with each release, so users are likely to want, for example,
both LLVM-2.6 and LLVM-2.7 installed at the same time to support apps developed
against each.

Compile Flags
=============

LLVM runs much more quickly when it's optimized and assertions are removed.
However, such a build is currently incompatible with users who build without
defining ``NDEBUG``, and the lack of assertions makes it hard to debug problems
in user code. We recommend allowing users to install both optimized and debug
versions of LLVM in parallel. The following configure flags are relevant:

``--disable-assertions``
Builds LLVM with ``NDEBUG`` defined. Changes the LLVM ABI. Also available
by setting ``DISABLE_ASSERTIONS=0|1`` in ``make``'s environment. This
defaults to enabled regardless of the optimization setting, but it slows
things down.

``--enable-debug-symbols``
Builds LLVM with ``-g``. Also available by setting ``DEBUG_SYMBOLS=0|1`` in
``make``'s environment. This defaults to disabled when optimizing, so you
should turn it back on to let users debug their programs.

``--enable-optimized``
(For svn checkouts) Builds LLVM with ``-O2`` and, by default, turns off
debug symbols. Also available by setting ``ENABLE_OPTIMIZED=0|1`` in
``make``'s environment. This defaults to enabled when not in a
checkout.

C++ Features
============

RTTI
LLVM disables RTTI by default. Add ``REQUIRES_RTTI=1`` to your environment
while running ``make`` to re-enable it. This will allow users to build with
RTTI enabled and still inherit from LLVM classes.

Shared Library
==============

Configure with ``--enable-shared`` to build
``libLLVM-<major>.<minor>.(so|dylib)`` and link the tools against it. This
saves lots of binary size at the cost of some startup time.

Dependencies
============

``--enable-libffi``
Depend on `libffi <http://sources.redhat.com/libffi/>`_ to allow the LLVM
interpreter to call external functions.

``--with-oprofile``

Depend on `libopagent
<http://oprofile.sourceforge.net/doc/devel/index.html>`_ (>=version 0.9.4)
to let the LLVM JIT tell oprofile about function addresses and line
numbers.
3 changes: 2 additions & 1 deletion docs/userguides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ User Guides
DeveloperPolicy
FAQ
Lexicon
Packaging

* `The LLVM Getting Started Guide <GettingStarted.html>`_

Expand Down Expand Up @@ -67,7 +68,7 @@ User Guides

Instructions for building the clang front-end from source.

* `Packaging guide <Packaging.html>`_
* :ref:`packaging`

Advice on packaging LLVM into a distribution.

Expand Down

0 comments on commit 1d4e628

Please sign in to comment.