[llvm-commits] [lld] r154275 - in /lld/trunk/docs: _templates/index.html conf.py contents.rst index.rst intro.rst
Michael J. Spencer
bigcheesegs at gmail.com
Sat Apr 7 19:06:04 PDT 2012
Author: mspencer
Date: Sat Apr 7 21:06:04 2012
New Revision: 154275
URL: http://llvm.org/viewvc/llvm-project?rev=154275&view=rev
Log:
[docs] Make the index page ReST based instead of html based.
Added:
lld/trunk/docs/index.rst
Removed:
lld/trunk/docs/_templates/index.html
lld/trunk/docs/contents.rst
lld/trunk/docs/intro.rst
Modified:
lld/trunk/docs/conf.py
Removed: lld/trunk/docs/_templates/index.html
URL: http://llvm.org/viewvc/llvm-project/lld/trunk/docs/_templates/index.html?rev=154274&view=auto
==============================================================================
--- lld/trunk/docs/_templates/index.html (original)
+++ lld/trunk/docs/_templates/index.html (removed)
@@ -1,37 +0,0 @@
-{% extends "layout.html" %}
-{% set title = 'lld' %}
-{% block body %}
-<h1>lld: a linker for LLVM</h1>
-
-For more information, see the <a href="{{pathto('intro')}}">introduction</a>
-and <a href="{{pathto('design')}}">design</a> available as part of the <i>lld</i>
-documentation below.
-
-<h2>Documentation</h2>
-<table class="contentstable" align="center" style="margin-left: 30px">
- <tr>
- <td width="50%">
- <p class="biglink"><a class="biglink" href="{{ pathto('contents') }}">
- Contents</a><br/>
- <span class="linkdescr">for a complete overview</span></p>
- <p class="biglink"><a class="biglink" href="{{ pathto('search') }}">
- Search page</a><br/>
- <span class="linkdescr">search the documentation</span></p>
- <p class="biglink"><a class="biglink" href="{{ pathto('genindex') }}">
- General Index</a><br/>
- <span class="linkdescr">all functions, classes, terms</span></p>
- </td></tr>
-</table>
-
-<h2>Source</h2>
-<p>lld is available in the LLVM SVN repository:
- <tt>svn co
- <a href="http://llvm.org/svn/llvm-project/lld/trunk">
- http://llvm.org/svn/llvm-project/lld/trunk</a></tt>.</p>
-
-<p>lld is also available via the read-only git mirror:
- <tt>git clone
- <a href="http://llvm.org/git/lld.git">
- http://llvm.org/git/lld.git</a></tt>.</p>
-
-{% endblock %}
Modified: lld/trunk/docs/conf.py
URL: http://llvm.org/viewvc/llvm-project/lld/trunk/docs/conf.py?rev=154275&r1=154274&r2=154275&view=diff
==============================================================================
--- lld/trunk/docs/conf.py (original)
+++ lld/trunk/docs/conf.py Sat Apr 7 21:06:04 2012
@@ -36,7 +36,7 @@
#source_encoding = 'utf-8-sig'
# The master toctree document.
-master_doc = 'contents'
+master_doc = 'index'
# General information about the project.
project = u'lld'
@@ -134,7 +134,7 @@
# Additional templates that should be rendered to pages, maps page names to
# template names.
-html_additional_pages = {'index': 'index.html'}
+# html_additional_pages = {'index': 'index.html'}
# If false, no module index is generated.
#html_domain_indices = True
Removed: lld/trunk/docs/contents.rst
URL: http://llvm.org/viewvc/llvm-project/lld/trunk/docs/contents.rst?rev=154274&view=auto
==============================================================================
--- lld/trunk/docs/contents.rst (original)
+++ lld/trunk/docs/contents.rst (removed)
@@ -1,19 +0,0 @@
-.. _contents:
-
-Contents
-========
-
-.. toctree::
- :maxdepth: 2
-
- intro
- design
- development
- open_projects
- sphinx_intro
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`
Added: lld/trunk/docs/index.rst
URL: http://llvm.org/viewvc/llvm-project/lld/trunk/docs/index.rst?rev=154275&view=auto
==============================================================================
--- lld/trunk/docs/index.rst (added)
+++ lld/trunk/docs/index.rst Sat Apr 7 21:06:04 2012
@@ -0,0 +1,79 @@
+.. _index:
+
+lld - The LLVM Linker
+=====================
+
+lld is a new set of modular code for creating linker tools.
+
+* End-User Features:
+
+ * Compatible with existing linker options
+ * Reads standard Object Files (e.g. ELF, Mach-O, PE/COFF)
+ * Writes standard Executable Files (e.g. ELF, Mach-O, PE)
+ * Fast link times
+ * Minimal memory use
+ * Remove clang's reliance on "the system linker"
+ * Uses the LLVM `"UIUC" BSD-Style license`__.
+
+* Applications:
+
+ * Modular design
+ * Support cross linking
+ * Easy to add new CPU support
+ * Can be built as static tool or library
+
+* Design and Implementation:
+
+ * Extensive unit tests
+ * Internal linker model can be dumped/read to textual format
+ * Internal linker model can be dumped/read to a new native format
+ * Native format designed to be fast to read and write
+ * Additional linking features can be plugged in as "passes"
+ * OS specific and CPU specific code factored out
+
+Why a new linker?
+-----------------
+
+The fact that clang relies on whatever linker tool you happen to have installed
+means that clang has been very conservative adopting features which require a
+recent linker.
+
+In the same way that the MC layer of LLVM has removed clang's reliance on the
+system assembler tool, the lld project will remove clang's reliance on the
+system linker tool.
+
+
+Current Status
+--------------
+
+lld is in its very early stages of development.
+
+Source
+------
+
+lld is available in the LLVM SVN repository::
+
+ svn co http://llvm.org/svn/llvm-project/lld/trunk
+
+lld is also available via the read-only git mirror::
+
+ git clone http://llvm.org/git/lld.git
+
+Contents
+--------
+
+.. toctree::
+ :maxdepth: 2
+
+ design
+ development
+ open_projects
+ sphinx_intro
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`search`
+
+__ http://llvm.org/docs/DeveloperPolicy.html#license
Removed: lld/trunk/docs/intro.rst
URL: http://llvm.org/viewvc/llvm-project/lld/trunk/docs/intro.rst?rev=154274&view=auto
==============================================================================
--- lld/trunk/docs/intro.rst (original)
+++ lld/trunk/docs/intro.rst (removed)
@@ -1,66 +0,0 @@
-.. _intro:
-
-Introduction
-============
-
-lld is a new set of modular code for creating linker tools.
-
- * End-User Features:
-
- * Compatible with existing linker options
-
- * Reads standard Object Files (e.g. ELF, Mach-O, PE/COFF)
-
- * Writes standard Executable Files (e.g. ELF, Mach-O, PE)
-
- * Fast link times
-
- * Minimal memory use
-
- * Remove clang's reliance on "the system linker"
-
- * Uses the LLVM `"UIUC" BSD-Style license`__.
-
- * Applications:
-
- * Modular design
-
- * Support cross linking
-
- * Easy to add new CPU support
-
- * Can be built as static tool or library
-
- * Design and Implementation:
-
- * Extensive unit tests
-
- * Internal linker model can be dumped/read to textual format
-
- * Internal linker model can be dumped/read to a new native format
-
- * Native format designed to be fast to read and write
-
- * Additional linking features can be plugged in as "passes"
-
- * OS specific and CPU specific code factored out
-
-
-Why a new linker?
------------------
-
-The fact that clang relies on whatever linker tool you happen to have installed
-means that clang has been very conservative adopting features which require a
-recent linker.
-
-In the same way that the MC layer of LLVM has removed clang's reliance on the
-system assembler tool, the lld project will remove clang's reliance on the
-system linker tool.
-
-
-Current Status
---------------
-
-lld is in its very early stages of development.
-
-__ http://llvm.org/docs/DeveloperPolicy.html#license
More information about the llvm-commits
mailing list