aboutsummaryrefslogtreecommitdiffstats
path: root/tools
diff options
context:
space:
mode:
authorMikhail Glushenkov <foldr@codedgers.com>2008-12-13 02:28:58 +0000
committerMikhail Glushenkov <foldr@codedgers.com>2008-12-13 02:28:58 +0000
commitd565203d96bbc24f59d28d2be1616ae6bfba907a (patch)
treeb52c0569510a7f53feb41b7ef1e020fdad58b0c6 /tools
parent9e269f05dbf021560ec3d0647afab0aa7cfb35b2 (diff)
downloadexternal_llvm-d565203d96bbc24f59d28d2be1616ae6bfba907a.zip
external_llvm-d565203d96bbc24f59d28d2be1616ae6bfba907a.tar.gz
external_llvm-d565203d96bbc24f59d28d2be1616ae6bfba907a.tar.bz2
More cosmetic tweaks for llvmc docs.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60969 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'tools')
-rw-r--r--tools/llvmc/doc/LLVMC-Reference.rst49
-rw-r--r--tools/llvmc/doc/LLVMC-Tutorial.rst39
-rw-r--r--tools/llvmc/doc/footer.html12
-rw-r--r--tools/llvmc/doc/llvm-rst.css7
4 files changed, 64 insertions, 43 deletions
diff --git a/tools/llvmc/doc/LLVMC-Reference.rst b/tools/llvmc/doc/LLVMC-Reference.rst
index c01f0bb..3033cfc 100644
--- a/tools/llvmc/doc/LLVMC-Reference.rst
+++ b/tools/llvmc/doc/LLVMC-Reference.rst
@@ -1,7 +1,17 @@
===================================
Customizing LLVMC: Reference Manual
===================================
-:Author: Mikhail Glushenkov <foldr@codedegers.com>
+
+.. contents::
+
+.. raw:: html
+
+ <div class="doc_author">
+ <p>Written by <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a></p>
+ </div>
+
+Introduction
+============
LLVMC is a generic compiler driver, designed to be customizable and
extensible. It plays the same role for LLVM as the ``gcc`` program
@@ -16,11 +26,10 @@ by plugins, which can be either statically or dynamically linked. This
makes it possible to easily adapt LLVMC for other purposes - for
example, as a build tool for game resources.
-Because LLVMC employs TableGen [1]_ as its configuration language, you
+Because LLVMC employs TableGen_ as its configuration language, you
need to be familiar with it to customize LLVMC.
-
-.. contents::
+.. _TableGen: http://llvm.cs.uiuc.edu/docs/TableGenFundamentals.html
Compiling with LLVMC
@@ -580,23 +589,27 @@ Debugging
When writing LLVMC plugins, it can be useful to get a visual view of
the resulting compilation graph. This can be achieved via the command
-line option ``--view-graph``. This command assumes that Graphviz [2]_ and
-Ghostview [3]_ are installed. There is also a ``--dump-graph`` option that
-creates a Graphviz source file(``compilation-graph.dot``) in the
+line option ``--view-graph``. This command assumes that Graphviz_ and
+Ghostview_ are installed. There is also a ``--dump-graph`` option that
+creates a Graphviz source file (``compilation-graph.dot``) in the
current directory.
+.. _Graphviz: http://www.graphviz.org/
+.. _Ghostview: http://pages.cs.wisc.edu/~ghost/
-References
-==========
-
-.. [1] TableGen Fundamentals
- http://llvm.cs.uiuc.edu/docs/TableGenFundamentals.html
+.. raw:: html
-.. [2] Graphviz
- http://www.graphviz.org/
+ <hr />
+ <address>
+ <a href="http://jigsaw.w3.org/css-validator/check/referer">
+ <img src="http://jigsaw.w3.org/css-validator/images/vcss-blue"
+ alt="Valid CSS" /></a>
+ <a href="http://validator.w3.org/check?uri=referer">
+ <img src="http://www.w3.org/Icons/valid-xhtml10-blue"
+ alt="Valid XHTML 1.0 Transitional"/></a>
-.. [3] Ghostview
- http://pages.cs.wisc.edu/~ghost/
+ <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a><br />
+ <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br />
-.. raw:: html
- :file: footer.html
+ Last modified: $Date: 2008-12-11 11:34:48 -0600 (Thu, 11 Dec 2008) $
+ </address>
diff --git a/tools/llvmc/doc/LLVMC-Tutorial.rst b/tools/llvmc/doc/LLVMC-Tutorial.rst
index 40292ee..a27bb20 100644
--- a/tools/llvmc/doc/LLVMC-Tutorial.rst
+++ b/tools/llvmc/doc/LLVMC-Tutorial.rst
@@ -1,7 +1,17 @@
======================
Tutorial - Using LLVMC
======================
-:Author: Mikhail Glushenkov <foldr@codedegers.com>
+
+.. contents::
+
+.. raw:: html
+
+ <div class="doc_author">
+ <p>Written by <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a></p>
+ </div>
+
+Introduction
+============
LLVMC is a generic compiler driver, which plays the same role for LLVM
as the ``gcc`` program does for GCC - the difference being that LLVMC
@@ -11,9 +21,6 @@ dynamically or compiled in. This tutorial describes the basic usage
and configuration of LLVMC.
-.. contents::
-
-
Compiling with LLVMC
====================
@@ -32,9 +39,11 @@ command-line LLVMC usage, refer to the ``llvmc --help`` output.
Using LLVMC to generate toolchain drivers
=========================================
-LLVMC plugins are written mostly using TableGen [1]_, so you need to
+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
+
Start by compiling ``plugins/Simple/Simple.td``, which is a primitive
wrapper for ``gcc``::
@@ -93,11 +102,19 @@ file.
To learn more about LLVMC customization, refer to the reference
manual and plugin source code in the ``plugins`` directory.
-References
-==========
+.. raw:: html
-.. [1] TableGen Fundamentals
- http://llvm.cs.uiuc.edu/docs/TableGenFundamentals.html
+ <hr />
+ <address>
+ <a href="http://jigsaw.w3.org/css-validator/check/referer">
+ <img src="http://jigsaw.w3.org/css-validator/images/vcss-blue"
+ alt="Valid CSS" /></a>
+ <a href="http://validator.w3.org/check?uri=referer">
+ <img src="http://www.w3.org/Icons/valid-xhtml10-blue"
+ alt="Valid XHTML 1.0 Transitional"/></a>
-.. raw:: html
- :file: footer.html
+ <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a><br />
+ <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br />
+
+ Last modified: $Date: 2008-12-11 11:34:48 -0600 (Thu, 11 Dec 2008) $
+ </address>
diff --git a/tools/llvmc/doc/footer.html b/tools/llvmc/doc/footer.html
deleted file mode 100644
index 2292471..0000000
--- a/tools/llvmc/doc/footer.html
+++ /dev/null
@@ -1,12 +0,0 @@
-<hr />
-<address>
- <a href="http://jigsaw.w3.org/css-validator/check/referer"><img src="http://jigsaw.w3.org/css-validator/images/vcss-blue"
- alt="Valid CSS" /></a>
- <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10-blue"
- alt="Valid XHTML 1.0 Transitional"/></a>
-
- <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a><br />
- <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br />
-
- Last modified: $Date: 2008-12-11 11:34:48 -0600 (Thu, 11 Dec 2008) $
-</address>
diff --git a/tools/llvmc/doc/llvm-rst.css b/tools/llvmc/doc/llvm-rst.css
index 6937e4b..2ff9cca 100644
--- a/tools/llvmc/doc/llvm-rst.css
+++ b/tools/llvmc/doc/llvm-rst.css
@@ -41,7 +41,10 @@ h1 {
margin: 20pt 0pt 5pt 0pt;
}
-.title { padding-top: 0; margin-top: 0; text-align: left; font-size: 25pt }
+.title { padding-top: 0; margin-top: 0; text-align: left;
+ font-size: 25pt }
+
+#contents { font-weight: bold; }
h2 { width: 75%;
text-align: left; font-size: 12pt; padding: 4pt 4pt 4pt 4pt;
margin: 1.5em 0.5em 0.5em 0.5em }
@@ -67,7 +70,7 @@ h3 { margin: 2.0em 0.5em 0.5em 0.5em;
.literal-block { border: solid 1px gray; background: #eeeeee;
margin: 0 1em 0 1em;
- padding: 0 1em 0 1em;
+ padding: 1em 2em 1em 1em;
display:table;
}
.doc_notes { background: #fafafa; border: 1px solid #cecece; padding: 0.1em }