[llvm-commits] [llvm] r73596 - in /llvm/trunk/tools/llvmc/doc: LLVMC-Reference.rst LLVMC-Tutorial.rst

[Mikhail Glushenkov]

Author: foldr
Date: Tue Jun 16 21:56:08 2009
New Revision: 73596

URL: http://llvm.org/viewvc/llvm-project?rev=73596&view=rev
Log:
Another small documentation update.

Modified:
    llvm/trunk/tools/llvmc/doc/LLVMC-Reference.rst
    llvm/trunk/tools/llvmc/doc/LLVMC-Tutorial.rst

Modified: llvm/trunk/tools/llvmc/doc/LLVMC-Reference.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/tools/llvmc/doc/LLVMC-Reference.rst?rev=73596&r1=73595&r2=73596&view=diff

==============================================================================
--- llvm/trunk/tools/llvmc/doc/LLVMC-Reference.rst (original)
+++ llvm/trunk/tools/llvmc/doc/LLVMC-Reference.rst Tue Jun 16 21:56:08 2009
@@ -33,7 +33,7 @@
 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 @@
      $ ./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 @@
 
 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 @@
     $ 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

Modified: llvm/trunk/tools/llvmc/doc/LLVMC-Tutorial.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/tools/llvmc/doc/LLVMC-Tutorial.rst?rev=73596&r1=73595&r2=73596&view=diff

==============================================================================
--- llvm/trunk/tools/llvmc/doc/LLVMC-Tutorial.rst (original)
+++ llvm/trunk/tools/llvmc/doc/LLVMC-Tutorial.rst Tue Jun 16 21:56:08 2009
@@ -46,12 +46,13 @@
 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.