From a6a22233a8f785e44bcb7c2717bd7586708332dd Mon Sep 17 00:00:00 2001 From: Sean Silva Date: Sat, 30 Mar 2013 15:32:47 +0000 Subject: [docs] Put DeveloperPolicy under "Development Process Documentation" git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@178421 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 8f22ef2a77..9c5c11af57 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -72,7 +72,6 @@ representation. CMake HowToBuildOnARM CommandGuide/index - DeveloperPolicy GettingStarted GettingStartedVS FAQ @@ -108,9 +107,6 @@ representation. Tutorials about using LLVM. Includes a tutorial about making a custom language with LLVM. -:doc:`DeveloperPolicy` - The LLVM project's policy towards developers and their contributions. - :doc:`LLVM Command Guide ` A reference manual for the LLVM command line utilities ("man" pages for LLVM tools). @@ -324,12 +320,16 @@ Information about LLVM's development process. .. toctree:: :hidden: + DeveloperPolicy MakefileGuide Projects LLVMBuild HowToReleaseLLVM Packaging +:doc:`DeveloperPolicy` + The LLVM project's policy towards developers and their contributions. + :doc:`Projects` How-to guide and templates for new projects that *use* the LLVM infrastructure. The templates (directory organization, Makefiles, and test -- cgit v1.2.3-18-g5258 From cad9b9cdb46b52f7e56dd5bfbfe8e813781f1b3d Mon Sep 17 00:00:00 2001 From: Sean Silva Date: Sat, 30 Mar 2013 15:32:50 +0000 Subject: [docs] The GEP FAQ is not "design and overview" git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@178422 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/index.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 9c5c11af57..a5be6daae2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -22,7 +22,6 @@ Several introductory papers and presentations. :hidden: LangRef - GetElementPtr :doc:`LangRef` Defines the LLVM intermediate representation. @@ -48,10 +47,6 @@ Several introductory papers and presentations. .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html -:doc:`GetElementPtr` - Answers to some very frequent questions about LLVM's most frequently - misunderstood instruction. - `Publications mentioning LLVM `_ .. @@ -86,6 +81,7 @@ representation. ReleaseNotes Passes YamlIO + GetElementPtr :doc:`GettingStarted` Discusses how to get up and running quickly with the LLVM infrastructure. @@ -145,6 +141,10 @@ representation. :doc:`YamlIO` A reference guide for using LLVM's YAML I/O library. +:doc:`GetElementPtr` + Answers to some very frequent questions about LLVM's most frequently + misunderstood instruction. + IRC === -- cgit v1.2.3-18-g5258 From bd1aecbea78a2ac0093ae85e906c8bc326c3732d Mon Sep 17 00:00:00 2001 From: Sean Silva Date: Sat, 30 Mar 2013 15:32:51 +0000 Subject: [docs] Pull IRC and Mailing Lists under a new "Community" heading. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@178423 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/index.rst | 50 +++++++++++++++++++++++++++++--------------------- 1 file changed, 29 insertions(+), 21 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index a5be6daae2..eac07cf2c8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -145,26 +145,6 @@ representation. Answers to some very frequent questions about LLVM's most frequently misunderstood instruction. -IRC -=== - -Users and developers of the LLVM project (including subprojects such as Clang) -can be found in #llvm on `irc.oftc.net `_. - -This channel has several bots. - -* Buildbot reporters - - * llvmbb - Bot for the main LLVM buildbot master. - http://lab.llvm.org:8011/console - * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console - * smooshlab - Apple's internal buildbot master. - -* robot - Bugzilla linker. %bug - -* clang-bot - A `geordi `_ instance running - near-trunk clang instead of gcc. - Programming Documentation ========================= @@ -349,8 +329,15 @@ Information about LLVM's development process. :doc:`Packaging` Advice on packaging LLVM into a distribution. +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. + Mailing Lists -============= +------------- If you can't find what you need in these docs, try consulting the mailing lists. @@ -389,6 +376,27 @@ lists. .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/ +IRC +--- + +Users and developers of the LLVM project (including subprojects such as Clang) +can be found in #llvm on `irc.oftc.net `_. + +This channel has several bots. + +* Buildbot reporters + + * llvmbb - Bot for the main LLVM buildbot master. + http://lab.llvm.org:8011/console + * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console + * smooshlab - Apple's internal buildbot master. + +* robot - Bugzilla linker. %bug + +* clang-bot - A `geordi `_ instance running + near-trunk clang instead of gcc. + + Indices and tables ================== -- cgit v1.2.3-18-g5258 From 135856526cf94852d45e0b77e6a80e1388e38fec Mon Sep 17 00:00:00 2001 From: Sean Silva Date: Sat, 30 Mar 2013 15:32:54 +0000 Subject: [docs] Reorganize mailing lists. Order them roughly by "which one should a newbie join first". git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@178424 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/index.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index eac07cf2c8..ef8b2c350f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -342,12 +342,6 @@ Mailing Lists If you can't find what you need in these docs, try consulting the mailing lists. -`LLVM Announcements List`__ - This is a low volume list that provides important announcements regarding - LLVM. It gets email about once a month. - - .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce - `Developer's List`__ 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 @@ -355,13 +349,6 @@ lists. .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev -`Bugs & Patches Archive`__ - This list gets emailed every time a bug is opened and closed, and when people - submit patches to be included in LLVM. It is higher volume than the LLVMdev - list. - - .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/ - `Commits Archive`__ This list contains all commit messages that are made when LLVM developers commit code changes to the repository. It is useful for those who want to @@ -369,6 +356,13 @@ lists. .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/ +`Bugs & Patches Archive`__ + This list gets emailed every time a bug is opened and closed, and when people + submit patches to be included in LLVM. It is higher volume than the LLVMdev + list. + + .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/ + `Test Results Archive`__ 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, @@ -376,6 +370,12 @@ lists. .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/ +`LLVM Announcements List`__ + This is a low volume list that provides important announcements regarding + LLVM. It gets email about once a month. + + .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce + IRC --- -- cgit v1.2.3-18-g5258 From fb7aa394359288e1201e9118044ededaed74f621 Mon Sep 17 00:00:00 2001 From: Sean Silva Date: Sat, 30 Mar 2013 15:33:01 +0000 Subject: [docs] Annotate mailing lists with their "name". Nobody says "the developer's list" or "commits archive"; they always say "llvmdev" or "llvm-commits". It makes sense for our documentation to at least make that association explicitly. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@178425 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/index.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index ef8b2c350f..ed2be3f2c3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -342,35 +342,35 @@ Mailing Lists If you can't find what you need in these docs, try consulting the mailing lists. -`Developer's List`__ +`Developer's List (llvmdev)`__ 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.cs.uiuc.edu/mailman/listinfo/llvmdev -`Commits Archive`__ +`Commits Archive (llvm-commits)`__ This list contains all commit messages that are made when LLVM developers commit code changes to the repository. It is useful for those who want to stay on the bleeding edge of LLVM development. This list is very high volume. .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/ -`Bugs & Patches Archive`__ +`Bugs & Patches Archive (llvmbugs)`__ This list gets emailed every time a bug is opened and closed, and when people submit patches to be included in LLVM. It is higher volume than the LLVMdev list. .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/ -`Test Results Archive`__ +`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.cs.uiuc.edu/pipermail/llvm-testresults/ -`LLVM Announcements List`__ +`LLVM Announcements List (llvm-announce)`__ This is a low volume list that provides important announcements regarding LLVM. It gets email about once a month. -- cgit v1.2.3-18-g5258 From 6ef362a6de0e5d503385df6d7710442951944f1a Mon Sep 17 00:00:00 2001 From: Sean Silva Date: Sat, 30 Mar 2013 15:33:02 +0000 Subject: [docs] llvmbugs is not the place for patches. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@178426 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/index.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index ed2be3f2c3..fcfb3953da 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -351,15 +351,16 @@ lists. `Commits Archive (llvm-commits)`__ This list contains all commit messages that are made when LLVM developers - commit code changes to the repository. It is useful for those who want to - stay on the bleeding edge of LLVM development. This list is very high volume. + 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.cs.uiuc.edu/pipermail/llvm-commits/ `Bugs & Patches Archive (llvmbugs)`__ - This list gets emailed every time a bug is opened and closed, and when people - submit patches to be included in LLVM. It is higher volume than the LLVMdev - list. + This list gets emailed every time a bug is opened and closed. It is + higher volume than the LLVMdev list. .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/ -- cgit v1.2.3-18-g5258 From 531ebc8a3cf0fdc5c30d072ab356283ce8dd145f Mon Sep 17 00:00:00 2001 From: Justin Holewinski Date: Sat, 30 Mar 2013 16:41:14 +0000 Subject: Add start of user documentation for NVPTX Summary: This is the beginning of user documentation for the NVPTX back-end. I want to ensure I am integrating this properly into the rest of the LLVM documentation. Differential Revision: http://llvm-reviews.chandlerc.com/D600 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@178428 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/index.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index fcfb3953da..c3bb8089da 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -224,6 +224,7 @@ For API clients and LLVM developers. WritingAnLLVMPass TableGen/LangRef HowToUseAttributes + NVPTXUsage :doc:`WritingAnLLVMPass` Information on how to write LLVM transformations and analyses. @@ -292,6 +293,10 @@ For API clients and LLVM developers. :doc:`HowToUseAttributes` Answers some questions about the new Attributes infrastructure. +:doc:`NVPTXUsage` + This document describes using the NVPTX back-end to compile GPU kernels. + + Development Process Documentation ================================= -- cgit v1.2.3-18-g5258