maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/docs/GettingInvolved.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

292 lines
10 KiB
ReStructuredText
Raw Normal View History

[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-22 04:56:40 +08:00
Getting Involved
================
LLVM welcomes contributions of all kinds. To get started, please review the following topics:
[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 08:49:02 +08:00
.. contents::
:local:
[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-22 04:56:40 +08:00
.. toctree::
:hidden:
Contributing
DeveloperPolicy
Add the CodeReview Documentation to GettingInvolved TOC
2020-03-07 12:55:46 +08:00
CodeReview
[docs] Adding a Support Policy As discussed in the mailing list [1-4], we need a separation of support tiers when requiring support from the whole community versus a sub-community. Essentially, if a sub-community is active enough and takes maintenance into their own internal costs without affecting other parts of the community's maintenance costs, then code that is not immediately relevant to all parts (ie. not released, actively tested, etc) can still find its way into the LLVM main repository without major pain points. The main benefit is to reduce the maintenance cost that those sub-communities have outside of LLVM (for example, in duplicating common code, applying the same patches on top of multiple user repositories or downstream projects). This document outlines the components and responsibilities of the sub-communities with regards to maintenance costs and how they affect the rest of the community. It also adds an addendum on removal policies, which expand the existing "new target removal" policy into something more generic, to encompass any piece of code, scripts or documents in the repository. [1] http://lists.llvm.org/pipermail/llvm-dev/2020-October/146249.html [2] http://lists.llvm.org/pipermail/llvm-dev/2020-November/146335.html [3] http://lists.llvm.org/pipermail/llvm-dev/2020-October/146138.html [4] http://lists.llvm.org/pipermail/llvm-dev/2020-November/146298.html
2020-11-04 21:15:59 +08:00
SupportPolicy
[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-22 04:56:40 +08:00
SphinxQuickstartTemplate
Phabricator
HowToSubmitABug
BugLifeCycle
CodingStandards
add GitBisecting to toctrees to try and placate the sphinx bot
2020-02-11 04:33:20 +08:00
GitBisecting
[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-22 04:56:40 +08:00
:doc:`Contributing`
An overview on how to contribute to LLVM.
:doc:`DeveloperPolicy`
The LLVM project's policy towards developers and their contributions.
Add the CodeReview Documentation to GettingInvolved TOC
2020-03-07 12:55:46 +08:00
:doc:`CodeReview`
The LLVM project's code-review process.
[docs] Adding a Support Policy As discussed in the mailing list [1-4], we need a separation of support tiers when requiring support from the whole community versus a sub-community. Essentially, if a sub-community is active enough and takes maintenance into their own internal costs without affecting other parts of the community's maintenance costs, then code that is not immediately relevant to all parts (ie. not released, actively tested, etc) can still find its way into the LLVM main repository without major pain points. The main benefit is to reduce the maintenance cost that those sub-communities have outside of LLVM (for example, in duplicating common code, applying the same patches on top of multiple user repositories or downstream projects). This document outlines the components and responsibilities of the sub-communities with regards to maintenance costs and how they affect the rest of the community. It also adds an addendum on removal policies, which expand the existing "new target removal" policy into something more generic, to encompass any piece of code, scripts or documents in the repository. [1] http://lists.llvm.org/pipermail/llvm-dev/2020-October/146249.html [2] http://lists.llvm.org/pipermail/llvm-dev/2020-November/146335.html [3] http://lists.llvm.org/pipermail/llvm-dev/2020-October/146138.html [4] http://lists.llvm.org/pipermail/llvm-dev/2020-November/146298.html
2020-11-04 21:15:59 +08:00
:doc:`SupportPolicy`
The LLVM support policy for core and non-core components.
[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-22 04:56:40 +08:00
: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.
add GitBisecting to toctrees to try and placate the sphinx bot
2020-02-11 04:33:20 +08:00
:doc:`GitBisecting`
Describes how to use ``git bisect`` on LLVM's repository.
[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-22 04:56:40 +08:00
.. _development-process:
Development Process
-------------------
Information about LLVM's development process.
.. toctree::
:hidden:
Projects
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:`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:
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
[docs] Describe reporting security issues on the chromium tracker. To track security issues, we're starting with the chromium bug tracker (using the llvm project there). We considered using Github Security Advisories. However, they are currently intended as a way for project owners to publicize their security advisories, and aren't well-suited to reporting issues. This also moves the issue-reporting paragraph to the beginning of the document, in part to make it more discoverable, in part to allow the anchor-linking to actually display the paragraph at the top of the page. Note that this doesn't update the concrete list of security-sensitive areas, which is still an open item. When we do, we may want to move the list of security-sensitive areas next to the issue-reporting paragraph as well, as it seems like relevant information needed in the reporting process. Finally, when describing the discission medium, this splits the topics discussed into two: the concrete security issues, discussed in the issue tracker, and the logistics of the group, in our mailing list, as patches on public lists, and in the monthly sync-up call. While there, add a SECURITY.md page linking to the relevant paragraph. Differential Revision: https://reviews.llvm.org/D100873
2021-04-21 01:31:26 +08:00
.. _online-sync-ups:
[docs] Document regular LLVM sync-ups This documents current regular LLVM sync-ups that are happening in the Getting Involved section. I hope this gives a bit more visibility to regular sync-ups that are happening in the LLVM community, documenting another way communication in the community happens. Of course the downside is that this is another location that sync-up metadata needs to be maintained. That being said, the structure as proposed means that no changes are needed once a new sync-up is added, apart from maybe removing the entry once it becomes clear that that particular sync-up series is completely cancelled. Documenting a few pointers on how current sync-ups happen may also encourage others to organize useful sync-ups on specific topics. I've started with adding the sync-ups I'm aware of. There's a good chance I've missed some. If most sync-ups end up having a public google calendar, we could also create and maintain a public google calendar that shows all events happening in the LLVM community, including dev meetings, sync-ups, socials, etc - assuming that would be valuable. Differential Revision: https://reviews.llvm.org/D98797
2021-03-18 00:55:56 +08:00
Online Sync-Ups
---------------
A number of regular calls are organized on specific topics. It should be
expected that the range of topics will change over time. At the time of
writing, the following sync-ups are organized:
.. list-table:: LLVM regular sync-up calls
:widths: 25 25 25 25
:header-rows: 1
* - Topic
- Frequency
- Calendar link
- Minutes/docs link
* - RISC-V
- Every 2 weeks on Thursday
- `ics <https://calendar.google.com/calendar/ical/lowrisc.org_0n5pkesfjcnp0bh5hps1p0bd80%40group.calendar.google.com/public/basic.ics>`__
`gcal <https://calendar.google.com/calendar/b/1?cid=bG93cmlzYy5vcmdfMG41cGtlc2ZqY25wMGJoNWhwczFwMGJkODBAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__
-
* - Scalable Vectors and Arm SVE
- Monthly, every 3rd Tuesday
[docs] Add calendar info for SVE sync-ups
2021-03-19 17:27:34 +08:00
- `ics <https://calendar.google.com/calendar/ical/bjms39pe6k6bo5egtsp7don414%40group.calendar.google.com/public/basic.ics>`__
`gcal <https://calendar.google.com/calendar/u/0/embed?src=bjms39pe6k6bo5egtsp7don414@group.calendar.google.com>`__
[docs] Document regular LLVM sync-ups This documents current regular LLVM sync-ups that are happening in the Getting Involved section. I hope this gives a bit more visibility to regular sync-ups that are happening in the LLVM community, documenting another way communication in the community happens. Of course the downside is that this is another location that sync-up metadata needs to be maintained. That being said, the structure as proposed means that no changes are needed once a new sync-up is added, apart from maybe removing the entry once it becomes clear that that particular sync-up series is completely cancelled. Documenting a few pointers on how current sync-ups happen may also encourage others to organize useful sync-ups on specific topics. I've started with adding the sync-ups I'm aware of. There's a good chance I've missed some. If most sync-ups end up having a public google calendar, we could also create and maintain a public google calendar that shows all events happening in the LLVM community, including dev meetings, sync-ups, socials, etc - assuming that would be valuable. Differential Revision: https://reviews.llvm.org/D98797
2021-03-18 00:55:56 +08:00
- `Minutes/docs <https://docs.google.com/document/d/1UPH2Hzou5RgGT8XfO39OmVXKEibWPfdYLELSaHr3xzo/edit>`__
* - ML Guided Compiler Optimizations
- Monthly
-
- `Minutes/docs <https://docs.google.com/document/d/1JecbplF09l3swTjze-UVeLh4L48svJxGVy4mz_e9Rhs/edit?usp=gmail#heading=h.ts9cmcjbir1j>`__
* - `LLVM security group <https://llvm.org/docs/Security.html>`__
- Monthly, every 3rd Tuesday
- `ics <https://calendar.google.com/calendar/ical/eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com/public/basic.ics>`__
`gcal <https://calendar.google.com/calendar/embed?src=eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com>`__
- `Minutes/docs <https://docs.google.com/document/d/1GLCE8cl7goCaLSiM9j1eIq5IqeXt6_YTY2UEcC4jmsg/edit?usp=sharing>`__
* - `CIRCT <https://github.com/llvm/circt>`__
- Weekly, on Wednesday
-
- `Minutes/docs <https://docs.google.com/document/d/1fOSRdyZR2w75D87yU2Ma9h2-_lEPL4NxvhJGJd-s5pk/edit#heading=h.mulvhjtr8dk9>`__
* - `MLIR <https://mlir.llvm.org>`__ design meetings
- Weekly, on Thursdays
-
- `Minutes/docs <https://docs.google.com/document/d/1y_9f1AbfgcoVdJh4_aM6-BaSHvrHl8zuA5G4jv_94K8/edit#heading=h.cite1kolful9>`__
[docs] GettingInvolved: split out flang and openmp meeting series Split out the flang and openmp meeting series, as each has a separate canonical page where the information is maintained. As part of that, also call out the alias analysis series separately as it doesn't seem to be relevant for just flang. Differential Revision: https://reviews.llvm.org/D99012
2021-03-20 16:09:39 +08:00
* - flang
[docs] Document regular LLVM sync-ups This documents current regular LLVM sync-ups that are happening in the Getting Involved section. I hope this gives a bit more visibility to regular sync-ups that are happening in the LLVM community, documenting another way communication in the community happens. Of course the downside is that this is another location that sync-up metadata needs to be maintained. That being said, the structure as proposed means that no changes are needed once a new sync-up is added, apart from maybe removing the entry once it becomes clear that that particular sync-up series is completely cancelled. Documenting a few pointers on how current sync-ups happen may also encourage others to organize useful sync-ups on specific topics. I've started with adding the sync-ups I'm aware of. There's a good chance I've missed some. If most sync-ups end up having a public google calendar, we could also create and maintain a public google calendar that shows all events happening in the LLVM community, including dev meetings, sync-ups, socials, etc - assuming that would be valuable. Differential Revision: https://reviews.llvm.org/D98797
2021-03-18 00:55:56 +08:00
- Multiple meeting series, `documented here <https://github.com/llvm/llvm-project/blob/main/flang/docs/GettingInvolved.md#calls>`__
-
-
[docs] GettingInvolved: split out flang and openmp meeting series Split out the flang and openmp meeting series, as each has a separate canonical page where the information is maintained. As part of that, also call out the alias analysis series separately as it doesn't seem to be relevant for just flang. Differential Revision: https://reviews.llvm.org/D99012
2021-03-20 16:09:39 +08:00
* - OpenMP
- Multiple meeting series, `documented here <https://openmp.llvm.org/docs/SupportAndFAQ.html>`__
-
-
* - LLVM Alias Analysis
- Every 4 weeks on Tuesdays
- `ics <http://lists.llvm.org/pipermail/llvm-dev/attachments/20201103/a3499a67/attachment-0001.ics>`__
- `Minutes/docs <https://docs.google.com/document/d/17U-WvX8qyKc3S36YUKr3xfF-GHunWyYowXbxEdpHscw>`__
[docs] Add Windows/COFF call info
2021-04-12 23:07:02 +08:00
* - Windows/COFF related developments
- Every 2 months on Thursday
-
- `Minutes/docs <https://docs.google.com/document/d/1A-W0Sas_oHWTEl_x_djZYoRtzAdTONMW_6l1BH9G6Bo/edit?usp=sharing>`__
[docs] Add vector predication call Add the syncup call to the table Reviewed By: craig.topper Differential Revision: https://reviews.llvm.org/D100474
2021-04-16 16:45:40 +08:00
* - Vector Predication
- Every 2 weeks on Tuesdays, 3pm UTC
-
- `Minutes/docs <https://docs.google.com/document/d/1q26ToudQjnqN5x31zk8zgq_s0lem1-BF8pQmciLa4k8/edit?usp=sharing>`__
[docs] Add Pointer Authentication call info
2021-04-16 21:10:52 +08:00
* - LLVM Pointer Authentication
- Every month on Mondays
- `ics <https://calendar.google.com/calendar/ical/fr1qtmrmt2s9odufjvurkb6j70%40group.calendar.google.com/public/basic.ics>`__
- `Minutes/docs <https://docs.google.com/document/d/14IDnh3YY9m6Ej_PaRKOz8tTTZlObgtLl8mYeRbytAec/edit?usp=sharing>`__
Add monthly MemorySSA sync.
2021-05-05 02:23:12 +08:00
* - MemorySSA in LLVM
[docs]Update meeeting frequency to match new cal entry
2021-08-02 14:48:25 +08:00
- Every 8 weeks on Mondays
Add cal entry for MemorySSA syncs.
2021-05-05 03:40:49 +08:00
- `ics <https://calendar.google.com/calendar/ical/c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com/public/basic.ics>`__
`gcal <https://calendar.google.com/calendar/embed?src=c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com>`__
Add monthly MemorySSA sync.
2021-05-05 02:23:12 +08:00
- `Minutes/docs <https://docs.google.com/document/d/1-uEEZfmRdPThZlctOq9eXlmUaSSAAi8oKxhrPY_lpjk/edit#>`__
[docs] Document regular LLVM sync-ups This documents current regular LLVM sync-ups that are happening in the Getting Involved section. I hope this gives a bit more visibility to regular sync-ups that are happening in the LLVM community, documenting another way communication in the community happens. Of course the downside is that this is another location that sync-up metadata needs to be maintained. That being said, the structure as proposed means that no changes are needed once a new sync-up is added, apart from maybe removing the entry once it becomes clear that that particular sync-up series is completely cancelled. Documenting a few pointers on how current sync-ups happen may also encourage others to organize useful sync-ups on specific topics. I've started with adding the sync-ups I'm aware of. There's a good chance I've missed some. If most sync-ups end up having a public google calendar, we could also create and maintain a public google calendar that shows all events happening in the LLVM community, including dev meetings, sync-ups, socials, etc - assuming that would be valuable. Differential Revision: https://reviews.llvm.org/D98797
2021-03-18 00:55:56 +08: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-22 04:56:40 +08:00
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-social-events:
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-proposals:
Community wide proposals
------------------------
Proposals for massive changes in how the community behaves and how the work flow
can be better.
.. toctree::
:hidden:
CodeOfConduct
Proposals/GitHubMove
BugpointRedesign
Proposals/LLVMLibC
Proposals/TestSuite
Proposals/VariableNames
Proposals/VectorizationPlan
[Doc] Proposal for vector predication Summary: Proposal and roadmap towards vector predication in LLVM. This patch documents that a) It is recognized that current LLVM is ill-equipped for vector predication. b) The community is working on a solution. c) A concrete prototype exists in the VP extension (D57504). Reviewers: rkruppe, rengolin, cameron.mcinally, SjoerdMeijer, andrew.w.kaylor, craig.topper, sdesmalen, k-ishizaka, lattner, fhahn Reviewed By: andrew.w.kaylor Subscribers: rogfer01, merge_guards_bot, simoncook, s.egerton, llvm-commits, efocht Tags: #llvm Differential Revision: https://reviews.llvm.org/D73889
2020-02-10 17:34:58 +08:00
Proposals/VectorPredication
[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-22 04:56:40 +08:00
: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.
:doc:`Proposals/VectorizationPlan`
[Doc] Proposal for vector predication Summary: Proposal and roadmap towards vector predication in LLVM. This patch documents that a) It is recognized that current LLVM is ill-equipped for vector predication. b) The community is working on a solution. c) A concrete prototype exists in the VP extension (D57504). Reviewers: rkruppe, rengolin, cameron.mcinally, SjoerdMeijer, andrew.w.kaylor, craig.topper, sdesmalen, k-ishizaka, lattner, fhahn Reviewed By: andrew.w.kaylor Subscribers: rogfer01, merge_guards_bot, simoncook, s.egerton, llvm-commits, efocht Tags: #llvm Differential Revision: https://reviews.llvm.org/D73889
2020-02-10 17:34:58 +08:00
Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
:doc:`Proposals/VectorPredication`
Proposal for predicated vector instructions in LLVM.