summaryrefslogtreecommitdiff
path: root/tools/llvmc
diff options
context:
space:
mode:
authorMikhail Glushenkov <foldr@codedgers.com>2009-06-17 02:56:08 +0000
committerMikhail Glushenkov <foldr@codedgers.com>2009-06-17 02:56:08 +0000
commit4aecec1f50d5bca914055e46daae3f6f75bd1cb0 (patch)
treec4357efbf9a0e87cb7d12c109af2ad65fdb9ca0c /tools/llvmc
parentc447ff693e9979c61f58b8e97dcfdbcfe7e10554 (diff)
downloadllvm-4aecec1f50d5bca914055e46daae3f6f75bd1cb0.tar.gz
llvm-4aecec1f50d5bca914055e46daae3f6f75bd1cb0.tar.bz2
llvm-4aecec1f50d5bca914055e46daae3f6f75bd1cb0.tar.xz
Another small documentation update.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@73596 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'tools/llvmc')
-rw-r--r--tools/llvmc/doc/LLVMC-Reference.rst22
-rw-r--r--tools/llvmc/doc/LLVMC-Tutorial.rst3
2 files changed, 13 insertions, 12 deletions
diff --git a/tools/llvmc/doc/LLVMC-Reference.rst b/tools/llvmc/doc/LLVMC-Reference.rst
index 1c04ecc39e..7befe8f02d 100644
--- a/tools/llvmc/doc/LLVMC-Reference.rst
+++ b/tools/llvmc/doc/LLVMC-Reference.rst
@@ -33,7 +33,7 @@ example, as a build tool for game resources.
Because LLVMC employs TableGen_ as its configuration language, you
need to be familiar with it to customize LLVMC.
-.. _TableGen: http://llvm.cs.uiuc.edu/docs/TableGenFundamentals.html
+.. _TableGen: http://llvm.org/docs/TableGenFundamentals.html
Compiling with LLVMC
@@ -48,12 +48,12 @@ you shouldn't be able to notice them::
$ ./a.out
hello
-One nice feature of LLVMC is that one doesn't have to distinguish
-between different compilers for different languages (think ``g++`` and
-``gcc``) - the right toolchain is chosen automatically based on input
-language names (which are, in turn, determined from file
-extensions). If you want to force files ending with ".c" to compile as
-C++, use the ``-x`` option, just like you would do it with ``gcc``::
+One nice feature of LLVMC is that one doesn't have to distinguish between
+different compilers for different languages (think ``g++`` vs. ``gcc``) - the
+right toolchain is chosen automatically based on input language names (which
+are, in turn, determined from file extensions). If you want to force files
+ending with ".c" to compile as C++, use the ``-x`` option, just like you would
+do it with ``gcc``::
$ # hello.c is really a C++ file
$ llvmc -x c++ hello.c
@@ -148,13 +148,13 @@ generic::
To build your plugin as a dynamic library, just ``cd`` to its source
directory and run ``make``. The resulting file will be called
-``LLVMC$(LLVMC_PLUGIN).$(DLL_EXTENSION)`` (in our case,
-``LLVMCMyPlugin.so``). This library can be then loaded in with the
+``plugin_llvmc_$(LLVMC_PLUGIN).$(DLL_EXTENSION)`` (in our case,
+``plugin_llvmc_MyPlugin.so``). This library can be then loaded in with the
``-load`` option. Example::
$ cd $LLVMC_DIR/plugins/Simple
$ make
- $ llvmc -load $LLVM_DIR/Release/lib/LLVMCSimple.so
+ $ llvmc -load $LLVM_DIR/Release/lib/plugin_llvmc_Simple.so
Compiling standalone LLVMC-based drivers
========================================
@@ -187,7 +187,7 @@ Another way to do the same thing is by using the following command::
$ cd $LLVMC_DIR
$ make LLVMC_BUILTIN_PLUGINS=MyPlugin LLVMC_BASED_DRIVER_NAME=mydriver
-This works with both srcdir==objdir and srcdir != objdir, but assumes that the
+This works with both srcdir == objdir and srcdir != objdir, but assumes that the
plugin source directory was placed under ``$LLVMC_DIR/plugins``.
Sometimes, you will want a 'bare-bones' version of LLVMC that has no
diff --git a/tools/llvmc/doc/LLVMC-Tutorial.rst b/tools/llvmc/doc/LLVMC-Tutorial.rst
index f7eb30e48a..e7e8f081e0 100644
--- a/tools/llvmc/doc/LLVMC-Tutorial.rst
+++ b/tools/llvmc/doc/LLVMC-Tutorial.rst
@@ -46,12 +46,13 @@ Using LLVMC to generate toolchain drivers
LLVMC plugins are written mostly using TableGen_, so you need to
be familiar with it to get anything done.
-.. _TableGen: http://llvm.cs.uiuc.edu/docs/TableGenFundamentals.html
+.. _TableGen: http://llvm.org/docs/TableGenFundamentals.html
Start by compiling ``example/Simple``, which is a primitive wrapper for
``gcc``::
$ cd $LLVM_DIR/tools/llvmc
+ $ cp -r example/Simple plugins/Simple
# NB: A less verbose way to compile standalone LLVMC-based drivers is
# described in the reference manual.