--- /dev/null
+Getting Involved\r
+================\r
+\r
+LLVM welcomes contributions of all kinds. To get started, please review the following topics:\r
+\r
+.. toctree::\r
+ :hidden:\r
+\r
+ Contributing\r
+ DeveloperPolicy\r
+ SphinxQuickstartTemplate\r
+ Phabricator\r
+ HowToSubmitABug\r
+ BugLifeCycle\r
+ CodingStandards\r
+\r
+:doc:`Contributing`\r
+ An overview on how to contribute to LLVM.\r
+\r
+:doc:`DeveloperPolicy`\r
+ The LLVM project's policy towards developers and their contributions.\r
+\r
+:doc:`SphinxQuickstartTemplate`\r
+ A template + tutorial for writing new Sphinx documentation. It is meant\r
+ to be read in source form.\r
+\r
+:doc:`Phabricator`\r
+ Describes how to use the Phabricator code review tool hosted on\r
+ http://reviews.llvm.org/ and its command line interface, Arcanist.\r
+\r
+:doc:`HowToSubmitABug`\r
+ Instructions for properly submitting information about any bugs you run into\r
+ in the LLVM system.\r
+\r
+:doc:`BugLifeCycle`\r
+ Describes how bugs are reported, triaged and closed.\r
+\r
+:doc:`CodingStandards`\r
+ Details the LLVM coding standards and provides useful information on writing\r
+ efficient C++ code.\r
+\r
+.. _development-process:\r
+\r
+Development Process\r
+-------------------\r
+\r
+Information about LLVM's development process.\r
+\r
+.. toctree::\r
+ :hidden:\r
+\r
+ Projects\r
+ LLVMBuild\r
+ HowToReleaseLLVM\r
+ Packaging\r
+ ReleaseProcess\r
+ HowToAddABuilder\r
+ ReleaseNotes\r
+\r
+:doc:`Projects`\r
+ How-to guide and templates for new projects that *use* the LLVM\r
+ infrastructure. The templates (directory organization, Makefiles, and test\r
+ tree) allow the project code to be located outside (or inside) the ``llvm/``\r
+ tree, while using LLVM header files and libraries.\r
+\r
+:doc:`LLVMBuild`\r
+ Describes the LLVMBuild organization and files used by LLVM to specify\r
+ component descriptions.\r
+\r
+:doc:`HowToReleaseLLVM`\r
+ This is a guide to preparing LLVM releases. Most developers can ignore it.\r
+\r
+:doc:`ReleaseProcess`\r
+ This is a guide to validate a new release, during the release process. Most developers can ignore it.\r
+\r
+:doc:`HowToAddABuilder`\r
+ Instructions for adding new builder to LLVM buildbot master.\r
+\r
+:doc:`Packaging`\r
+ Advice on packaging LLVM into a distribution.\r
+\r
+:doc:`Release notes for the current release <ReleaseNotes>`\r
+ This describes new features, known bugs, and other limitations.\r
+\r
+.. _mailing-lists:\r
+\r
+Mailing Lists\r
+-------------\r
+\r
+If you can't find what you need in these docs, try consulting the mailing\r
+lists.\r
+\r
+`Developer's List (llvm-dev)`__\r
+ This list is for people who want to be included in technical discussions of\r
+ LLVM. People post to this list when they have questions about writing code\r
+ for or using the LLVM tools. It is relatively low volume.\r
+\r
+ .. __: http://lists.llvm.org/mailman/listinfo/llvm-dev\r
+\r
+`Commits Archive (llvm-commits)`__\r
+ This list contains all commit messages that are made when LLVM developers\r
+ commit code changes to the repository. It also serves as a forum for\r
+ patch review (i.e. send patches here). It is useful for those who want to\r
+ stay on the bleeding edge of LLVM development. This list is very high\r
+ volume.\r
+\r
+ .. __: http://lists.llvm.org/pipermail/llvm-commits/\r
+\r
+`Bugs & Patches Archive (llvm-bugs)`__\r
+ This list gets emailed every time a bug is opened and closed. It is\r
+ higher volume than the LLVM-dev list.\r
+\r
+ .. __: http://lists.llvm.org/pipermail/llvm-bugs/\r
+\r
+`Test Results Archive (llvm-testresults)`__\r
+ A message is automatically sent to this list by every active nightly tester\r
+ when it completes. As such, this list gets email several times each day,\r
+ making it a high volume list.\r
+\r
+ .. __: http://lists.llvm.org/pipermail/llvm-testresults/\r
+\r
+`LLVM Announcements List (llvm-announce)`__\r
+ This is a low volume list that provides important announcements regarding\r
+ LLVM. It gets email about once a month.\r
+\r
+ .. __: http://lists.llvm.org/mailman/listinfo/llvm-announce\r
+\r
+IRC\r
+---\r
+\r
+Users and developers of the LLVM project (including subprojects such as Clang)\r
+can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.\r
+\r
+This channel has several bots.\r
+\r
+* Buildbot reporters\r
+\r
+ * llvmbb - Bot for the main LLVM buildbot master.\r
+ http://lab.llvm.org:8011/console\r
+ * smooshlab - Apple's internal buildbot master.\r
+\r
+* robot - Bugzilla linker. %bug <number>\r
+\r
+* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running\r
+ near-trunk clang instead of gcc.\r
+\r
+.. _meetups-social-events:\r
+\r
+Meetups and social events\r
+-------------------------\r
+\r
+.. toctree::\r
+ :hidden:\r
+\r
+ MeetupGuidelines\r
+\r
+Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,\r
+there are several user groups called\r
+`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to\r
+join one in your city. Or start a new one if there is none:\r
+\r
+:doc:`MeetupGuidelines`\r
+\r
+.. _community-proposals:\r
+\r
+Community wide proposals\r
+------------------------\r
+\r
+Proposals for massive changes in how the community behaves and how the work flow\r
+can be better.\r
+\r
+.. toctree::\r
+ :hidden:\r
+\r
+ CodeOfConduct\r
+ Proposals/GitHubMove\r
+ BugpointRedesign\r
+ Proposals/LLVMLibC\r
+ Proposals/TestSuite\r
+ Proposals/VariableNames\r
+ Proposals/VectorizationPlan\r
+\r
+:doc:`CodeOfConduct`\r
+ Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,\r
+ IRC, etc).\r
+\r
+:doc:`Proposals/GitHubMove`\r
+ Proposal to move from SVN/Git to GitHub.\r
+\r
+:doc:`BugpointRedesign`\r
+ Design doc for a redesign of the Bugpoint tool.\r
+\r
+:doc:`Proposals/LLVMLibC`\r
+ Proposal to add a libc implementation under the LLVM project.\r
+\r
+:doc:`Proposals/TestSuite`\r
+ Proposals for additional benchmarks/programs for llvm's test-suite.\r
+\r
+:doc:`Proposals/VariableNames`\r
+ Proposal to change the variable names coding standard.\r
+\r
+:doc:`Proposals/VectorizationPlan`\r
+ Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
\ No newline at end of file
Reference
---------
-.. toctree::
- :hidden:
-
LLVM and API reference documentation.
.. toctree::
Community
=========
-LLVM has a thriving community of friendly and helpful developers.
-The two primary communication mechanisms in the LLVM community are mailing
-lists and IRC.
-
-Getting Involved
-----------------
-
-LLVM welcomes contributions of all kinds. To get started, please review the following topics:
-
-.. toctree::
- :hidden:
-
- Contributing
- DeveloperPolicy
- SphinxQuickstartTemplate
- Phabricator
- HowToSubmitABug
- BugLifeCycle
- CodingStandards
-
-:doc:`Contributing`
- An overview on how to contribute to LLVM.
-
-:doc:`DeveloperPolicy`
- The LLVM project's policy towards developers and their contributions.
-
-:doc:`SphinxQuickstartTemplate`
- A template + tutorial for writing new Sphinx documentation. It is meant
- to be read in source form.
-
-:doc:`Phabricator`
- Describes how to use the Phabricator code review tool hosted on
- http://reviews.llvm.org/ and its command line interface, Arcanist.
-
-:doc:`HowToSubmitABug`
- Instructions for properly submitting information about any bugs you run into
- in the LLVM system.
-
-:doc:`BugLifeCycle`
- Describes how bugs are reported, triaged and closed.
-
-:doc:`CodingStandards`
- Details the LLVM coding standards and provides useful information on writing
- efficient C++ code.
-
-Development Process
--------------------
-
-Information about LLVM's development process.
-
-.. toctree::
- :hidden:
-
- Projects
- LLVMBuild
- HowToReleaseLLVM
- Packaging
- ReleaseProcess
- HowToAddABuilder
- ReleaseNotes
-
-:doc:`Projects`
- How-to guide and templates for new projects that *use* the LLVM
- infrastructure. The templates (directory organization, Makefiles, and test
- tree) allow the project code to be located outside (or inside) the ``llvm/``
- tree, while using LLVM header files and libraries.
-
-:doc:`LLVMBuild`
- Describes the LLVMBuild organization and files used by LLVM to specify
- component descriptions.
-
-:doc:`HowToReleaseLLVM`
- This is a guide to preparing LLVM releases. Most developers can ignore it.
-
-:doc:`ReleaseProcess`
- This is a guide to validate a new release, during the release process. Most developers can ignore it.
-
-:doc:`HowToAddABuilder`
- Instructions for adding new builder to LLVM buildbot master.
-
-:doc:`Packaging`
- Advice on packaging LLVM into a distribution.
-
-:doc:`Release notes for the current release <ReleaseNotes>`
- This describes new features, known bugs, and other limitations.
-
-Mailing Lists
--------------
-
-If you can't find what you need in these docs, try consulting the mailing
-lists.
-
-`Developer's List (llvm-dev)`__
- This list is for people who want to be included in technical discussions of
- LLVM. People post to this list when they have questions about writing code
- for or using the LLVM tools. It is relatively low volume.
-
- .. __: http://lists.llvm.org/mailman/listinfo/llvm-dev
-
-`Commits Archive (llvm-commits)`__
- This list contains all commit messages that are made when LLVM developers
- commit code changes to the repository. It also serves as a forum for
- patch review (i.e. send patches here). It is useful for those who want to
- stay on the bleeding edge of LLVM development. This list is very high
- volume.
-
- .. __: http://lists.llvm.org/pipermail/llvm-commits/
-
-`Bugs & Patches Archive (llvm-bugs)`__
- This list gets emailed every time a bug is opened and closed. It is
- higher volume than the LLVM-dev list.
-
- .. __: http://lists.llvm.org/pipermail/llvm-bugs/
-
-`Test Results Archive (llvm-testresults)`__
- A message is automatically sent to this list by every active nightly tester
- when it completes. As such, this list gets email several times each day,
- making it a high volume list.
-
- .. __: http://lists.llvm.org/pipermail/llvm-testresults/
-
-`LLVM Announcements List (llvm-announce)`__
- This is a low volume list that provides important announcements regarding
- LLVM. It gets email about once a month.
-
- .. __: http://lists.llvm.org/mailman/listinfo/llvm-announce
-
-IRC
----
-
-Users and developers of the LLVM project (including subprojects such as Clang)
-can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
-
-This channel has several bots.
-
-* Buildbot reporters
-
- * llvmbb - Bot for the main LLVM buildbot master.
- http://lab.llvm.org:8011/console
- * smooshlab - Apple's internal buildbot master.
-
-* robot - Bugzilla linker. %bug <number>
-
-* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
- near-trunk clang instead of gcc.
-
-Meetups and social events
--------------------------
-
-.. toctree::
- :hidden:
-
- MeetupGuidelines
-
-Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,
-there are several user groups called
-`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to
-join one in your city. Or start a new one if there is none:
-
-:doc:`MeetupGuidelines`
-
-Community wide proposals
-------------------------
-
-Proposals for massive changes in how the community behaves and how the work flow
-can be better.
+LLVM welcomes contributions of all kinds. To learn more, see the following articles:
.. toctree::
:hidden:
- CodeOfConduct
- Proposals/GitHubMove
- BugpointRedesign
- Proposals/LLVMLibC
- Proposals/TestSuite
- Proposals/VariableNames
- Proposals/VectorizationPlan
-
-:doc:`CodeOfConduct`
- Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,
- IRC, etc).
-
-:doc:`Proposals/GitHubMove`
- Proposal to move from SVN/Git to GitHub.
-
-:doc:`BugpointRedesign`
- Design doc for a redesign of the Bugpoint tool.
-
-:doc:`Proposals/LLVMLibC`
- Proposal to add a libc implementation under the LLVM project.
-
-:doc:`Proposals/TestSuite`
- Proposals for additional benchmarks/programs for llvm's test-suite.
-
-:doc:`Proposals/VariableNames`
- Proposal to change the variable names coding standard.
+ GettingInvolved
-:doc:`Proposals/VectorizationPlan`
- Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
+* :doc:`GettingInvolved`
+* :ref:`development-process`
+* :ref:`mailing-lists`
+* :ref:`meetups-social-events`
+* :ref:`community-proposals`
Indices and tables
==================
projects / platform / upstream / llvm.git / commitdiff