From d01c8fe7a50c150ff0717011fc7c77eb7a34748b Mon Sep 17 00:00:00 2001 From: "Michael J. Spencer" Date: Sun, 8 Apr 2012 02:06:04 +0000 Subject: [PATCH] [docs] Make the index page ReST based instead of html based. llvm-svn: 154275 --- lld/docs/_templates/index.html | 37 ---------------- lld/docs/conf.py | 4 +- lld/docs/contents.rst | 19 -------- lld/docs/index.rst | 79 ++++++++++++++++++++++++++++++++++ lld/docs/intro.rst | 66 ---------------------------- 5 files changed, 81 insertions(+), 124 deletions(-) delete mode 100644 lld/docs/_templates/index.html delete mode 100644 lld/docs/contents.rst create mode 100644 lld/docs/index.rst delete mode 100644 lld/docs/intro.rst diff --git a/lld/docs/_templates/index.html b/lld/docs/_templates/index.html deleted file mode 100644 index 4f66d468ab1c..000000000000 --- a/lld/docs/_templates/index.html +++ /dev/null @@ -1,37 +0,0 @@ -{% extends "layout.html" %} -{% set title = 'lld' %} -{% block body %} -

lld: a linker for LLVM

- -For more information, see the introduction -and design available as part of the lld -documentation below. - -

Documentation

- - - -
-

- Contents
- for a complete overview

-

- Search page
- search the documentation

-

- General Index
- all functions, classes, terms

-
- -

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.

- -{% endblock %} diff --git a/lld/docs/conf.py b/lld/docs/conf.py index 00c017f1704a..815d5aea6895 100644 --- a/lld/docs/conf.py +++ b/lld/docs/conf.py @@ -36,7 +36,7 @@ source_suffix = '.rst' #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 @@ html_sidebars = {'index': 'indexsidebar.html'} # 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 diff --git a/lld/docs/contents.rst b/lld/docs/contents.rst deleted file mode 100644 index 18a3bc7a0609..000000000000 --- a/lld/docs/contents.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _contents: - -Contents -======== - -.. toctree:: - :maxdepth: 2 - - intro - design - development - open_projects - sphinx_intro - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`search` diff --git a/lld/docs/index.rst b/lld/docs/index.rst new file mode 100644 index 000000000000..94ff3487d635 --- /dev/null +++ b/lld/docs/index.rst @@ -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 diff --git a/lld/docs/intro.rst b/lld/docs/intro.rst deleted file mode 100644 index 1f45aa732aeb..000000000000 --- a/lld/docs/intro.rst +++ /dev/null @@ -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