From fbd815fb7a752f66cf7b27926a578dac4d756f17 Mon Sep 17 00:00:00 2001 From: Mikhail Glushenkov Date: Wed, 17 Jun 2009 02:56:08 +0000 Subject: [PATCH] Another small documentation update. llvm-svn: 73596 --- llvm/tools/llvmc/doc/LLVMC-Reference.rst | 22 +++++++++++----------- llvm/tools/llvmc/doc/LLVMC-Tutorial.rst | 3 ++- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/llvm/tools/llvmc/doc/LLVMC-Reference.rst b/llvm/tools/llvmc/doc/LLVMC-Reference.rst index 1c04ecc39ea9..7befe8f02d97 100644 --- a/llvm/tools/llvmc/doc/LLVMC-Reference.rst +++ b/llvm/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/llvm/tools/llvmc/doc/LLVMC-Tutorial.rst b/llvm/tools/llvmc/doc/LLVMC-Tutorial.rst index f7eb30e48abc..e7e8f081e0f1 100644 --- a/llvm/tools/llvmc/doc/LLVMC-Tutorial.rst +++ b/llvm/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. -- GitLab