RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-23 19:23:23 +01:00
Code Issues Projects Releases Wiki Activity
1a92d5b134
llvm-mirror/docs/index.rst

95 lines
2.0 KiB
ReStructuredText
Raw Normal View History

Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-05 19:30:52 +02:00
About
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-19 18:31:37 +02:00
========
.. warning::
If you are using a released version of LLVM, see `the download page
Doc: Links should use https
2020-03-22 22:42:03 +01:00
<https://llvm.org/releases/>`_ to find your documentation.
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-19 18:31:37 +02:00
The LLVM compiler infrastructure supports a wide range of projects, from
industrial strength compilers to specialized JIT applications to small
research projects.
Similarly, documentation is broken down into several high-level groupings
Fix typos found by http://github.com/lyda/misspell-check llvm-svn: 157885
2012-06-02 12:20:22 +02:00
targeted at different audiences:
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-19 18:31:37 +02:00
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
LLVM Design & Overview
======================
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-19 18:31:37 +02:00
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
Several introductory papers and presentations.
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-19 18:31:37 +02:00
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
.. toctree::
:hidden:
[Docs] Bug fix for document not included in toctree Fixes 'document not included in toctree' bug for FAQ and Lexicon topics. llvm-svn: 372470
2019-09-21 16:29:19 +02:00
FAQ
Lexicon
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 03:19:42 +01:00
`Introduction to the LLVM Compiler`__
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
Presentation providing a users introduction to LLVM.
Doc: Links should use https
2020-03-22 22:42:03 +01:00
.. __: https://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 03:19:42 +01:00
`Intro to LLVM`__
Make coding standards document more inclusive Summary: Patch by Doug Gregor, Tres Popp, and Dmitri Gribenko. Reviewers: chandlerc Subscribers: hfinkel, bmcreusillet, arsenm, doug.gregor, mgrang, arphaman, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D69354
2019-11-19 18:49:37 +01:00
A chapter from the book "The Architecture of Open Source Applications" that
describes high-level design decisions that shaped LLVM.
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 03:19:42 +01:00
.. __: http://www.aosabook.org/en/llvm.html
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 03:19:42 +01:00
`LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
Design overview.
Doc: Links should use https
2020-03-22 22:42:03 +01:00
.. __: https://llvm.org/pubs/2004-01-30-CGO-LLVM.html
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 03:19:42 +01:00
`LLVM: An Infrastructure for Multi-Stage Optimization`__
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
More details (quite old now).
Doc: Links should use https
2020-03-22 22:42:03 +01:00
.. __: https://llvm.org/pubs/2002-12-LattnerMSThesis.html
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-05 19:30:52 +02:00
Documentation
=============
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-05 19:30:52 +02:00
Getting Started, How-tos, Developer Guides, and Tutorials.
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
.. toctree::
:hidden:
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 17:36:37 +02:00
GettingStartedTutorials
[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
2019-09-25 02:49:02 +02:00
Reference
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 17:36:37 +02:00
UserGuides
[Docs] Bug fix for reference to nonexistent document This commit fixes a bug in which the toctree contained a reference to a non-existent document. llvm-svn: 371889
2019-09-13 22:05:57 +02:00
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 17:36:37 +02:00
:doc:`GettingStartedTutorials`
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-05 19:30:52 +02:00
For those new to the LLVM system.
[docs] Reinstate r337730 - Add support for Markdown documentation in Sphinx. We think the bot is updated now, so trying this again. I'm landing it (with permission) as Michael is at a con at the moment. Actual patch largely by Michael Spencer. Differential Revision: https://reviews.llvm.org/D44910 llvm-svn: 338977
2018-08-06 02:38:31 +02:00
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 17:36:37 +02:00
:doc:`UserGuides`
User guides and How-tos.
[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
2019-09-25 02:49:02 +02:00
:doc:`Reference`
LLVM and API reference documentation.
Docs: Update Community section on homepage This commit includes the following changes: Adds a Getting Involved section under Community. Moves the Development Process section under Community. Moves Sphinx Quickstart Template and How to submit an LLVM bug report from User Guides section to Getting Involved. llvm-svn: 371127
2019-09-05 23:24:47 +02:00
Community
=========
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 03:19:36 +01:00
[Docs] Adds new page for Getting Involved articles Adds a new page for existing Getting Involved, Development Process, and Community Proposals articles. Also moves Mailing Lists, Meetups and social events, and IRC sections. llvm-svn: 372487
2019-09-21 22:56:40 +02:00
LLVM welcomes contributions of all kinds. To learn more, see the following articles:
[docs] Add proposals to index file llvm-svn: 276099
2016-07-20 11:38:04 +02:00
.. toctree::
:hidden:
[Docs] Adds new page for Getting Involved articles Adds a new page for existing Getting Involved, Development Process, and Community Proposals articles. Also moves Mailing Lists, Meetups and social events, and IRC sections. llvm-svn: 372487
2019-09-21 22:56:40 +02:00
GettingInvolved
[Documentation] Proposal to change variable names Differential Revision: https://reviews.llvm.org/D59251 llvm-svn: 357174
2019-03-28 15:42:21 +01:00
[Docs] Adds new page for Getting Involved articles Adds a new page for existing Getting Involved, Development Process, and Community Proposals articles. Also moves Mailing Lists, Meetups and social events, and IRC sections. llvm-svn: 372487
2019-09-21 22:56:40 +02:00
* :doc:`GettingInvolved`
* :ref:`development-process`
* :ref:`mailing-lists`
* :ref:`meetups-social-events`
* :ref:`community-proposals`
[docs] Pull IRC and Mailing Lists under a new "Community" heading. llvm-svn: 178423
2013-03-30 16:32:51 +01:00
[docs] LLVM Security Group and Process Summary: See the corresponding RFC on llvm-dev for a discussion of this proposal. http://lists.llvm.org/pipermail/llvm-dev/2019-November/136839.html Subscribers: jkorous, dexonsmith, arphaman, ributzka, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D70326
2019-11-15 19:54:39 +01:00
Reporting a security issue
* :ref:`report-security-issue`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-19 18:31:37 +02:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`
Reference in New Issue Copy Permalink