1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>LLVM Developer Policy — LLVM 13 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/llvm-theme.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="LLVM Code-Review Policy and Practices" href="CodeReview.html" />
<link rel="prev" title="Contributing to LLVM" href="Contributing.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head><body>
<div class="logo">
<a href="index.html">
<img src="_static/logo.png"
alt="LLVM Logo" width="250" height="88"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="CodeReview.html" title="LLVM Code-Review Policy and Practices"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="Contributing.html" title="Contributing to LLVM"
accesskey="P">previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="GettingInvolved.html" accesskey="U">Getting Involved</a> »</li>
<li class="nav-item nav-item-this"><a href="">LLVM Developer Policy</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Documentation</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
<li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
<li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
</ul>
<h3>Getting Involved</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/Contributing.html">Contributing to LLVM</a></li>
<li><a href="https://llvm.org/docs/HowToSubmitABug.html">Submitting Bug Reports</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#mailing-lists">Mailing Lists</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#irc">IRC</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#meetups-and-social-events">Meetups and Social Events</a></li>
</ul>
<h3>Additional Links</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li>
<li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li>
<li><a href="https://llvm.org/pubs">Publications</a></li>
<li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/DeveloperPolicy.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="llvm-developer-policy">
<h1>LLVM Developer Policy<a class="headerlink" href="#llvm-developer-policy" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#introduction" id="id7">Introduction</a></p></li>
<li><p><a class="reference internal" href="#developer-policies" id="id8">Developer Policies</a></p>
<ul>
<li><p><a class="reference internal" href="#stay-informed" id="id9">Stay Informed</a></p></li>
<li><p><a class="reference internal" href="#making-and-submitting-a-patch" id="id10">Making and Submitting a Patch</a></p></li>
<li><p><a class="reference internal" href="#code-reviews" id="id11">Code Reviews</a></p></li>
<li><p><a class="reference internal" href="#code-owners" id="id12">Code Owners</a></p></li>
<li><p><a class="reference internal" href="#test-cases" id="id13">Test Cases</a></p></li>
<li><p><a class="reference internal" href="#quality" id="id14">Quality</a></p></li>
<li><p><a class="reference internal" href="#commit-messages" id="id15">Commit messages</a></p></li>
<li><p><a class="reference internal" href="#patch-reversion-policy" id="id16">Patch reversion policy</a></p></li>
<li><p><a class="reference internal" href="#obtaining-commit-access" id="id17">Obtaining Commit Access</a></p></li>
<li><p><a class="reference internal" href="#making-a-major-change" id="id18">Making a Major Change</a></p></li>
<li><p><a class="reference internal" href="#incremental-development" id="id19">Incremental Development</a></p></li>
<li><p><a class="reference internal" href="#attribution-of-changes" id="id20">Attribution of Changes</a></p></li>
<li><p><a class="reference internal" href="#ir-backwards-compatibility" id="id21">IR Backwards Compatibility</a></p></li>
<li><p><a class="reference internal" href="#c-api-changes" id="id22">C API Changes</a></p></li>
<li><p><a class="reference internal" href="#updating-toolchain-requirements" id="id23">Updating Toolchain Requirements</a></p></li>
<li><p><a class="reference internal" href="#working-with-the-ci-system" id="id24">Working with the CI system</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#introducing-new-components-into-llvm" id="id25">Introducing New Components into LLVM</a></p>
<ul>
<li><p><a class="reference internal" href="#adding-a-new-target" id="id26">Adding a New Target</a></p></li>
<li><p><a class="reference internal" href="#adding-an-established-project-to-the-llvm-monorepo" id="id27">Adding an Established Project To the LLVM Monorepo</a></p></li>
<li><p><a class="reference internal" href="#incubating-new-projects" id="id28">Incubating New Projects</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#copyright-license-and-patents" id="id29">Copyright, License, and Patents</a></p>
<ul>
<li><p><a class="reference internal" href="#copyright" id="id30">Copyright</a></p></li>
<li><p><a class="reference internal" href="#relicensing" id="id31">Relicensing</a></p></li>
<li><p><a class="reference internal" href="#new-llvm-project-license-framework" id="id32">New LLVM Project License Framework</a></p></li>
<li><p><a class="reference internal" href="#patents" id="id33">Patents</a></p></li>
<li><p><a class="reference internal" href="#legacy-license-structure" id="id34">Legacy License Structure</a></p></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="introduction">
<h2><a class="toc-backref" href="#id7">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>This document contains the LLVM Developer Policy which defines the project’s
policy towards developers and their contributions. The intent of this policy is
to eliminate miscommunication, rework, and confusion that might arise from the
distributed nature of LLVM’s development. By stating the policy in clear terms,
we hope each developer can know ahead of time what to expect when making LLVM
contributions. This policy covers all llvm.org subprojects, including Clang,
LLDB, libc++, etc.</p>
<p>This policy is also designed to accomplish the following objectives:</p>
<ol class="arabic simple">
<li><p>Attract both users and developers to the LLVM project.</p></li>
<li><p>Make life as simple and easy for contributors as possible.</p></li>
<li><p>Keep the top of tree as stable as possible.</p></li>
<li><p>Establish awareness of the project’s <a class="reference internal" href="#copyright-license-patents"><span class="std std-ref">copyright, license, and patent
policies</span></a> with contributors to the project.</p></li>
</ol>
<p>This policy is aimed at frequent contributors to LLVM. People interested in
contributing one-off patches can do so in an informal way by sending them to the
<a class="reference external" href="http://lists.llvm.org/mailman/listinfo/llvm-commits">llvm-commits mailing list</a> and engaging another
developer to see it through the process.</p>
</div>
<div class="section" id="developer-policies">
<h2><a class="toc-backref" href="#id8">Developer Policies</a><a class="headerlink" href="#developer-policies" title="Permalink to this headline">¶</a></h2>
<p>This section contains policies that pertain to frequent LLVM developers. We
always welcome <a class="reference internal" href="#one-off-patches">one-off patches</a> from people who do not routinely contribute to
LLVM, but we expect more from frequent contributors to keep the system as
efficient as possible for everyone. Frequent LLVM contributors are expected to
meet the following requirements in order for LLVM to maintain a high standard of
quality.</p>
<div class="section" id="stay-informed">
<h3><a class="toc-backref" href="#id9">Stay Informed</a><a class="headerlink" href="#stay-informed" title="Permalink to this headline">¶</a></h3>
<p>Developers should stay informed by reading at least the “dev” mailing list for
the projects you are interested in, such as <a class="reference external" href="http://lists.llvm.org/mailman/listinfo/llvm-dev">llvm-dev</a> for LLVM, <a class="reference external" href="http://lists.llvm.org/mailman/listinfo/cfe-dev">cfe-dev</a> for Clang, or <a class="reference external" href="http://lists.llvm.org/mailman/listinfo/lldb-dev">lldb-dev</a> for LLDB. If you are
doing anything more than just casual work on LLVM, it is suggested that you also
subscribe to the “commits” mailing list for the subproject you’re interested in,
such as <a class="reference external" href="http://lists.llvm.org/mailman/listinfo/llvm-commits">llvm-commits</a>, <a class="reference external" href="http://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits</a>, or <a class="reference external" href="http://lists.llvm.org/mailman/listinfo/lldb-commits">lldb-commits</a>. Reading the
“commits” list and paying attention to changes being made by others is a good
way to see what other people are interested in and watching the flow of the
project as a whole.</p>
<p>We recommend that active developers register an email account with <a class="reference external" href="https://bugs.llvm.org/">LLVM
Bugzilla</a> and preferably subscribe to the <a class="reference external" href="http://lists.llvm.org/mailman/listinfo/llvm-bugs">llvm-bugs</a> email list to keep track
of bugs and enhancements occurring in LLVM. We really appreciate people who are
proactive at catching incoming bugs in their components and dealing with them
promptly.</p>
<p>Please be aware that all public LLVM mailing lists are public and archived, and
that notices of confidentiality or non-disclosure cannot be respected.</p>
</div>
<div class="section" id="making-and-submitting-a-patch">
<span id="one-off-patches"></span><span id="patch"></span><h3><a class="toc-backref" href="#id10">Making and Submitting a Patch</a><a class="headerlink" href="#making-and-submitting-a-patch" title="Permalink to this headline">¶</a></h3>
<p>When making a patch for review, the goal is to make it as easy for the reviewer
to read it as possible. As such, we recommend that you:</p>
<ol class="arabic simple">
<li><p>Make your patch against git main, not a branch, and not an old version
of LLVM. This makes it easy to apply the patch. For information on how to
clone from git, please see the <a class="reference internal" href="GettingStarted.html#checkout"><span class="std std-ref">Getting Started Guide</span></a>.</p></li>
<li><p>Similarly, patches should be submitted soon after they are generated. Old
patches may not apply correctly if the underlying code changes between the
time the patch was created and the time it is applied.</p></li>
<li><p>Patches should be made with <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">format-patch</span></code>, or similar (see special
commands for <a class="reference external" href="Phabricator.html#phabricator-request-review-web">Requesting Phabricator review via the web interface</a> ). If you use a
different tool, make sure it uses the <code class="docutils literal notranslate"><span class="pre">diff</span> <span class="pre">-u</span></code> format and that it
doesn’t contain clutter which makes it hard to read.</p></li>
</ol>
<p>Once your patch is ready, submit it by emailing it to the appropriate project’s
commit mailing list (or commit it directly if applicable). Alternatively, some
patches get sent to the project’s development list or component of the LLVM bug
tracker, but the commit list is the primary place for reviews and should
generally be preferred.</p>
<p>When sending a patch to a mailing list, it is a good idea to send it as an
<em>attachment</em> to the message, not embedded into the text of the message. This
ensures that your mailer will not mangle the patch when it sends it (e.g. by
making whitespace changes or by wrapping lines).</p>
<p><em>For Thunderbird users:</em> Before submitting a patch, please open <em>Preferences >
Advanced > General > Config Editor</em>, find the key
<code class="docutils literal notranslate"><span class="pre">mail.content_disposition_type</span></code>, and set its value to <code class="docutils literal notranslate"><span class="pre">1</span></code>. Without this
setting, Thunderbird sends your attachment using <code class="docutils literal notranslate"><span class="pre">Content-Disposition:</span> <span class="pre">inline</span></code>
rather than <code class="docutils literal notranslate"><span class="pre">Content-Disposition:</span> <span class="pre">attachment</span></code>. Apple Mail gamely displays such
a file inline, making it difficult to work with for reviewers using that
program.</p>
<p>When submitting patches, please do not add confidentiality or non-disclosure
notices to the patches themselves. These notices conflict with the LLVM
licensing terms and may result in your contribution being excluded.</p>
</div>
<div class="section" id="code-reviews">
<span id="code-review"></span><h3><a class="toc-backref" href="#id11">Code Reviews</a><a class="headerlink" href="#code-reviews" title="Permalink to this headline">¶</a></h3>
<p>LLVM has a code-review policy. Code review is one way to increase the quality of
software. Please see <a class="reference internal" href="CodeReview.html"><span class="doc">LLVM Code-Review Policy and Practices</span></a> for more information on LLVM’s code-review
process.</p>
</div>
<div class="section" id="code-owners">
<span id="id1"></span><h3><a class="toc-backref" href="#id12">Code Owners</a><a class="headerlink" href="#code-owners" title="Permalink to this headline">¶</a></h3>
<p>The LLVM Project relies on two features of its process to maintain rapid
development in addition to the high quality of its source base: the combination
of code review plus post-commit review for trusted maintainers. Having both is
a great way for the project to take advantage of the fact that most people do
the right thing most of the time, and only commit patches without pre-commit
review when they are confident they are right.</p>
<p>The trick to this is that the project has to guarantee that all patches that are
committed are reviewed after they go in: you don’t want everyone to assume
someone else will review it, allowing the patch to go unreviewed. To solve this
problem, we have a notion of an ‘owner’ for a piece of the code. The sole
responsibility of a code owner is to ensure that a commit to their area of the
code is appropriately reviewed, either by themself or by someone else. The list
of current code owners can be found in the file <a class="reference external" href="https://github.com/llvm/llvm-project/blob/main/llvm/CODE_OWNERS.TXT">CODE_OWNERS.TXT</a> in the
root of the LLVM source tree.</p>
<p>Note that code ownership is completely different than reviewers: anyone can
review a piece of code, and we welcome code review from anyone who is
interested. Code owners are the “last line of defense” to guarantee that all
patches that are committed are actually reviewed.</p>
<p>Being a code owner is a somewhat unglamorous position, but it is incredibly
important for the ongoing success of the project. Because people get busy,
interests change, and unexpected things happen, code ownership is purely opt-in,
and anyone can choose to resign their “title” at any time. For now, we do not
have an official policy on how one gets elected to be a code owner.</p>
</div>
<div class="section" id="test-cases">
<span id="include-a-testcase"></span><h3><a class="toc-backref" href="#id13">Test Cases</a><a class="headerlink" href="#test-cases" title="Permalink to this headline">¶</a></h3>
<p>Developers are required to create test cases for any bugs fixed and any new
features added. Some tips for getting your testcase approved:</p>
<ul class="simple">
<li><p>All feature and regression test cases are added to the <code class="docutils literal notranslate"><span class="pre">llvm/test</span></code>
directory. The appropriate sub-directory should be selected (see the
<a class="reference internal" href="TestingGuide.html"><span class="doc">Testing Guide</span></a> for details).</p></li>
<li><p>Test cases should be written in <a class="reference internal" href="LangRef.html"><span class="doc">LLVM assembly language</span></a>.</p></li>
<li><p>Test cases, especially for regressions, should be reduced as much as possible,
by <a class="reference internal" href="Bugpoint.html"><span class="doc">bugpoint</span></a> or manually. It is unacceptable to place an
entire failing program into <code class="docutils literal notranslate"><span class="pre">llvm/test</span></code> as this creates a <em>time-to-test</em>
burden on all developers. Please keep them short.</p></li>
</ul>
<p>Note that llvm/test and clang/test are designed for regression and small feature
tests only. More extensive test cases (e.g., entire applications, benchmarks,
etc) should be added to the <code class="docutils literal notranslate"><span class="pre">llvm-test</span></code> test suite. The llvm-test suite is
for coverage (correctness, performance, etc) testing, not feature or regression
testing.</p>
</div>
<div class="section" id="quality">
<h3><a class="toc-backref" href="#id14">Quality</a><a class="headerlink" href="#quality" title="Permalink to this headline">¶</a></h3>
<p>The minimum quality standards that any change must satisfy before being
committed to the main development branch are:</p>
<ol class="arabic simple">
<li><p>Code must adhere to the <a class="reference external" href="CodingStandards.html">LLVM Coding Standards</a>.</p></li>
<li><p>Code must compile cleanly (no errors, no warnings) on at least one platform.</p></li>
<li><p>Bug fixes and new features should <a class="reference internal" href="#include-a-testcase">include a testcase</a> so we know if the
fix/feature ever regresses in the future.</p></li>
<li><p>Code must pass the <code class="docutils literal notranslate"><span class="pre">llvm/test</span></code> test suite.</p></li>
<li><p>The code must not cause regressions on a reasonable subset of llvm-test,
where “reasonable” depends on the contributor’s judgement and the scope of
the change (more invasive changes require more testing). A reasonable subset
might be something like “<code class="docutils literal notranslate"><span class="pre">llvm-test/MultiSource/Benchmarks</span></code>”.</p></li>
</ol>
<p>Additionally, the committer is responsible for addressing any problems found in
the future that the change is responsible for. For example:</p>
<ul class="simple">
<li><p>The code should compile cleanly on all supported platforms.</p></li>
<li><p>The changes should not cause any correctness regressions in the <code class="docutils literal notranslate"><span class="pre">llvm-test</span></code>
suite and must not cause any major performance regressions.</p></li>
<li><p>The change set should not cause performance or correctness regressions for the
LLVM tools.</p></li>
<li><p>The changes should not cause performance or correctness regressions in code
compiled by LLVM on all applicable targets.</p></li>
<li><p>You are expected to address any <a class="reference external" href="https://bugs.llvm.org/">Bugzilla bugs</a> that
result from your change.</p></li>
</ul>
<p>We prefer for this to be handled before submission but understand that it isn’t
possible to test all of this for every submission. Our build bots and nightly
testing infrastructure normally finds these problems. A good rule of thumb is
to check the nightly testers for regressions the day after your change. Build
bots will directly email you if a group of commits that included yours caused a
failure. You are expected to check the build bot messages to see if they are
your fault and, if so, fix the breakage.</p>
<p>Commits that violate these quality standards (e.g. are very broken) may be
reverted. This is necessary when the change blocks other developers from making
progress. The developer is welcome to re-commit the change after the problem has
been fixed.</p>
</div>
<div class="section" id="commit-messages">
<span id="id2"></span><h3><a class="toc-backref" href="#id15">Commit messages</a><a class="headerlink" href="#commit-messages" title="Permalink to this headline">¶</a></h3>
<p>Although we don’t enforce the format of commit messages, we prefer that
you follow these guidelines to help review, search in logs, email formatting
and so on. These guidelines are very similar to rules used by other open source
projects.</p>
<p>Most importantly, the contents of the message should be carefully written to
convey the rationale of the change (without delving too much in detail). It
also should avoid being vague or overly specific. For example, “bits were not
set right” will leave the reviewer wondering about which bits, and why they
weren’t right, while “Correctly set overflow bits in TargetInfo” conveys almost
all there is to the change.</p>
<p>Below are some guidelines about the format of the message itself:</p>
<ul class="simple">
<li><p>Separate the commit message into title and body separated by a blank line.</p></li>
<li><p>If you’re not the original author, ensure the ‘Author’ property of the commit is
set to the original author and the ‘Committer’ property is set to yourself.
You can use a command similar to
<code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">--amend</span> <span class="pre">--author="John</span> <span class="pre">Doe</span> <span class="pre"><jdoe@llvm.org>"</span></code> to correct the
author property if it is incorrect. See <a class="reference internal" href="#attribution-of-changes">Attribution of Changes</a> for more
information including the method we used for attribution before the project
migrated to git.</p></li>
<li><p>The title should be concise. Because all commits are emailed to the list with
the first line as the subject, long titles are frowned upon. Short titles
also look better in <cite>git log</cite>.</p></li>
<li><p>When the changes are restricted to a specific part of the code (e.g. a
back-end or optimization pass), it is customary to add a tag to the
beginning of the line in square brackets. For example, “[SCEV] …”
or “[OpenMP] …”. This helps email filters and searches for post-commit
reviews.</p></li>
<li><p>The body, if it exists, should be separated from the title by an empty line.</p></li>
<li><p>The body should be concise, but explanatory, including a complete
reasoning. Unless it is required to understand the change, examples,
code snippets and gory details should be left to bug comments, web
review or the mailing list.</p></li>
<li><p>If the patch fixes a bug in bugzilla, please include the PR# in the message.</p></li>
<li><p>Text formatting and spelling should follow the same rules as documentation
and in-code comments, ex. capitalization, full stop, etc.</p></li>
<li><p>If the commit is a bug fix on top of another recently committed patch, or a
revert or reapply of a patch, include the git commit hash of the prior
related commit. This could be as simple as “Revert commit NNNN because it
caused PR#”.</p></li>
<li><p>If the patch has been reviewed, add a link to its review page, as shown
<a class="reference external" href="https://www.llvm.org/docs/Phabricator.html#committing-a-change">here</a>.</p></li>
</ul>
<p>For minor violations of these recommendations, the community normally favors
reminding the contributor of this policy over reverting. Minor corrections and
omissions can be handled by sending a reply to the commits mailing list.</p>
</div>
<div class="section" id="patch-reversion-policy">
<span id="revert-policy"></span><h3><a class="toc-backref" href="#id16">Patch reversion policy</a><a class="headerlink" href="#patch-reversion-policy" title="Permalink to this headline">¶</a></h3>
<p>As a community, we strongly value having the tip of tree in a good state while
allowing rapid iterative development. As such, we tend to make much heavier
use of reverts to keep the tree healthy than some other open source projects,
and our norms are a bit different.</p>
<p>How should you respond if someone reverted your change?</p>
<ul class="simple">
<li><p>Remember, it is normal and healthy to have patches reverted. Having a patch
reverted does not necessarily mean you did anything wrong.</p></li>
<li><p>We encourage explicitly thanking the person who reverted the patch for doing
the task on your behalf.</p></li>
<li><p>If you need more information to address the problem, please follow up in the
original commit thread with the reverting patch author.</p></li>
</ul>
<p>When should you revert your own change?</p>
<ul class="simple">
<li><p>Any time you learn of a serious problem with a change, you should revert it.
We strongly encourage “revert to green” as opposed to “fixing forward”. We
encourage reverting first, investigating offline, and then reapplying the
fixed patch - possibly after another round of review if warranted.</p></li>
<li><p>If you break a buildbot in a way which can’t be quickly fixed, please revert.</p></li>
<li><p>If a test case that demonstrates a problem is reported in the commit thread,
please revert and investigate offline.</p></li>
<li><p>If you receive substantial <a class="reference internal" href="CodeReview.html#post-commit-review"><span class="std std-ref">post-commit review</span></a>
feedback, please revert and address said feedback before recommitting.
(Possibly after another round of review.)</p></li>
<li><p>If you are asked to revert by another contributor, please revert and discuss
the merits of the request offline (unless doing so would further destabilize
tip of tree).</p></li>
</ul>
<p>When should you revert someone else’s change?</p>
<ul class="simple">
<li><p>In general, if the author themselves would revert the change per these
guidelines, we encourage other contributors to do so as a courtesy to the
author. This is one of the major cases where our norms differ from others;
we generally consider reverting a normal part of development. We don’t
expect contributors to be always available, and the assurance that a
problematic patch will be reverted and we can return to it at our next
opportunity enables this.</p></li>
</ul>
<p>What are the expectations around a revert?</p>
<ul class="simple">
<li><p>Use your best judgment. If you’re uncertain, please start an email on
the commit thread asking for assistance. We aren’t trying to enumerate
every case, but rather give a set of guidelines.</p></li>
<li><p>You should be sure that reverting the change improves the stability of tip
of tree. Sometimes reverting one change in a series can worsen things
instead of improving them. We expect reasonable judgment to ensure that
the proper patch or set of patches is being reverted.</p></li>
<li><p>The commit message for the reverting commit should explain why patch
is being reverted.</p></li>
<li><p>It is customary to respond to the original commit email mentioning the
revert. This serves as both a notice to the original author that their
patch was reverted, and helps others following llvm-commits track context.</p></li>
<li><p>Ideally, you should have a publicly reproducible test case ready to share.
Where possible, we encourage sharing of test cases in commit threads, or
in PRs. We encourage the reverter to minimize the test case and to prune
dependencies where practical. This even applies when reverting your own
patch; documenting the reasons for others who might be following along
is critical.</p></li>
<li><p>It is not considered reasonable to revert without at least the promise to
provide a means for the patch author to debug the root issue. If a situation
arises where a public reproducer can not be shared for some reason (e.g.
requires hardware patch author doesn’t have access to, sharp regression in
compile time of internal workload, etc.), the reverter is expected to be
proactive about working with the patch author to debug and test candidate
patches.</p></li>
<li><p>Reverts should be reasonably timely. A change submitted two hours ago
can be reverted without prior discussion. A change submitted two years ago
should not be. Where exactly the transition point is is hard to say, but
it’s probably in the handful of days in tree territory. If you are unsure,
we encourage you to reply to the commit thread, give the author a bit to
respond, and then proceed with the revert if the author doesn’t seem to be
actively responding.</p></li>
<li><p>When re-applying a reverted patch, the commit message should be updated to
indicate the problem that was addressed and how it was addressed.</p></li>
</ul>
</div>
<div class="section" id="obtaining-commit-access">
<h3><a class="toc-backref" href="#id17">Obtaining Commit Access</a><a class="headerlink" href="#obtaining-commit-access" title="Permalink to this headline">¶</a></h3>
<p>We grant commit access to contributors with a track record of submitting high
quality patches. If you would like commit access, please send an email to
<a class="reference external" href="mailto:clattner%40llvm.org">Chris</a> with your GitHub username. This is true
for former contributors with SVN access as well as new contributors.</p>
<p>Prior to obtaining commit access, it is common practice to request that
someone with commit access commits on your behalf. When doing so, please
provide the name and email address you would like to use in the Author
property of the commit.</p>
<p>Your first commit to a repository may require the autogenerated email to be
approved by a moderator of the mailing list.
This is normal and will be done when the mailing list owner has time.</p>
<p>If you have recently been granted commit access, these policies apply:</p>
<ol class="arabic simple">
<li><p>You are granted <em>commit-after-approval</em> to all parts of LLVM. For
information on how to get approval for a patch, please see <a class="reference internal" href="CodeReview.html"><span class="doc">LLVM Code-Review Policy and Practices</span></a>.
When approved, you may commit it yourself.</p></li>
<li><p>You are allowed to commit patches without approval which you think are
obvious. This is clearly a subjective decision — we simply expect you to
use good judgement. Examples include: fixing build breakage, reverting
obviously broken patches, documentation/comment changes, any other minor
changes. Avoid committing formatting- or whitespace-only changes outside of
code you plan to make subsequent changes to. Also, try to separate
formatting or whitespace changes from functional changes, either by
correcting the format first (ideally) or afterward. Such changes should be
highly localized and the commit message should clearly state that the commit
is not intended to change functionality, usually by stating it is
<a class="reference internal" href="Lexicon.html#nfc"><span class="std std-ref">NFC</span></a>.</p></li>
<li><p>You are allowed to commit patches without approval to those portions of LLVM
that you have contributed or maintain (i.e., have been assigned
responsibility for), with the proviso that such commits must not break the
build. This is a “trust but verify” policy, and commits of this nature are
reviewed after they are committed.</p></li>
<li><p>Multiple violations of these policies or a single egregious violation may
cause commit access to be revoked.</p></li>
</ol>
<p>In any case, your changes are still subject to <a class="reference internal" href="#code-review">code review</a> (either before or
after they are committed, depending on the nature of the change). You are
encouraged to review other peoples’ patches as well, but you aren’t required
to do so.</p>
</div>
<div class="section" id="making-a-major-change">
<span id="discuss-the-change-gather-consensus"></span><h3><a class="toc-backref" href="#id18">Making a Major Change</a><a class="headerlink" href="#making-a-major-change" title="Permalink to this headline">¶</a></h3>
<p>When a developer begins a major new project with the aim of contributing it back
to LLVM, they should inform the community with an email to the <a class="reference external" href="http://lists.llvm.org/mailman/listinfo/llvm-dev">llvm-dev</a> email list, to the extent
possible. The reason for this is to:</p>
<ol class="arabic simple">
<li><p>keep the community informed about future changes to LLVM,</p></li>
<li><p>avoid duplication of effort by preventing multiple parties working on the
same thing and not knowing about it, and</p></li>
<li><p>ensure that any technical issues around the proposed work are discussed and
resolved before any significant work is done.</p></li>
</ol>
<p>The design of LLVM is carefully controlled to ensure that all the pieces fit
together well and are as consistent as possible. If you plan to make a major
change to the way LLVM works or want to add a major new extension, it is a good
idea to get consensus with the development community before you start working on
it.</p>
<p>Once the design of the new feature is finalized, the work itself should be done
as a series of <a class="reference internal" href="#incremental-changes">incremental changes</a>, not as a long-term development branch.</p>
</div>
<div class="section" id="incremental-development">
<span id="incremental-changes"></span><h3><a class="toc-backref" href="#id19">Incremental Development</a><a class="headerlink" href="#incremental-development" title="Permalink to this headline">¶</a></h3>
<p>In the LLVM project, we do all significant changes as a series of incremental
patches. We have a strong dislike for huge changes or long-term development
branches. Long-term development branches have a number of drawbacks:</p>
<ol class="arabic simple">
<li><p>Branches must have mainline merged into them periodically. If the branch
development and mainline development occur in the same pieces of code,
resolving merge conflicts can take a lot of time.</p></li>
<li><p>Other people in the community tend to ignore work on branches.</p></li>
<li><p>Huge changes (produced when a branch is merged back onto mainline) are
extremely difficult to <a class="reference internal" href="#code-review">code review</a>.</p></li>
<li><p>Branches are not routinely tested by our nightly tester infrastructure.</p></li>
<li><p>Changes developed as monolithic large changes often don’t work until the
entire set of changes is done. Breaking it down into a set of smaller
changes increases the odds that any of the work will be committed to the main
repository.</p></li>
</ol>
<p>To address these problems, LLVM uses an incremental development style and we
require contributors to follow this practice when making a large/invasive
change. Some tips:</p>
<ul class="simple">
<li><p>Large/invasive changes usually have a number of secondary changes that are
required before the big change can be made (e.g. API cleanup, etc). These
sorts of changes can often be done before the major change is done,
independently of that work.</p></li>
<li><p>The remaining inter-related work should be decomposed into unrelated sets of
changes if possible. Once this is done, define the first increment and get
consensus on what the end goal of the change is.</p></li>
<li><p>Each change in the set can be stand alone (e.g. to fix a bug), or part of a
planned series of changes that works towards the development goal.</p></li>
<li><p>Each change should be kept as small as possible. This simplifies your work
(into a logical progression), simplifies code review and reduces the chance
that you will get negative feedback on the change. Small increments also
facilitate the maintenance of a high quality code base.</p></li>
<li><p>Often, an independent precursor to a big change is to add a new API and slowly
migrate clients to use the new API. Each change to use the new API is often
“obvious” and can be committed without review. Once the new API is in place
and used, it is much easier to replace the underlying implementation of the
API. This implementation change is logically separate from the API
change.</p></li>
</ul>
<p>If you are interested in making a large change, and this scares you, please make
sure to first <a class="reference internal" href="#discuss-the-change-gather-consensus">discuss the change/gather consensus</a> then ask about the best way
to go about making the change.</p>
</div>
<div class="section" id="attribution-of-changes">
<h3><a class="toc-backref" href="#id20">Attribution of Changes</a><a class="headerlink" href="#attribution-of-changes" title="Permalink to this headline">¶</a></h3>
<p>When contributors submit a patch to an LLVM project, other developers with
commit access may commit it for the author once appropriate (based on the
progression of code review, etc.). When doing so, it is important to retain
correct attribution of contributions to their contributors. However, we do not
want the source code to be littered with random attributions “this code written
by J. Random Hacker” (this is noisy and distracting). In practice, the revision
control system keeps a perfect history of who changed what, and the CREDITS.txt
file describes higher-level contributions. If you commit a patch for someone
else, please follow the attribution of changes in the simple manner as outlined
by the <a class="reference internal" href="#commit-messages">commit messages</a> section. Overall, please do not add contributor names
to the source code.</p>
<p>Also, don’t commit patches authored by others unless they have submitted the
patch to the project or you have been authorized to submit them on their behalf
(you work together and your company authorized you to contribute the patches,
etc.). The author should first submit them to the relevant project’s commit
list, development list, or LLVM bug tracker component. If someone sends you
a patch privately, encourage them to submit it to the appropriate list first.</p>
<p>Our previous version control system (subversion) did not distinguish between the
author and the committer like git does. As such, older commits used a different
attribution mechanism. The previous method was to include “Patch by John Doe.”
in a separate line of the commit message and there are automated processes that
rely on this format.</p>
</div>
<div class="section" id="ir-backwards-compatibility">
<span id="id4"></span><h3><a class="toc-backref" href="#id21">IR Backwards Compatibility</a><a class="headerlink" href="#ir-backwards-compatibility" title="Permalink to this headline">¶</a></h3>
<p>When the IR format has to be changed, keep in mind that we try to maintain some
backwards compatibility. The rules are intended as a balance between convenience
for llvm users and not imposing a big burden on llvm developers:</p>
<ul class="simple">
<li><p>The textual format is not backwards compatible. We don’t change it too often,
but there are no specific promises.</p></li>
<li><p>Additions and changes to the IR should be reflected in
<code class="docutils literal notranslate"><span class="pre">test/Bitcode/compatibility.ll</span></code>.</p></li>
<li><p>The current LLVM version supports loading any bitcode since version 3.0.</p></li>
<li><p>After each X.Y release, <code class="docutils literal notranslate"><span class="pre">compatibility.ll</span></code> must be copied to
<code class="docutils literal notranslate"><span class="pre">compatibility-X.Y.ll</span></code>. The corresponding bitcode file should be assembled
using the X.Y build and committed as <code class="docutils literal notranslate"><span class="pre">compatibility-X.Y.ll.bc</span></code>.</p></li>
<li><p>Newer releases can ignore features from older releases, but they cannot
miscompile them. For example, if nsw is ever replaced with something else,
dropping it would be a valid way to upgrade the IR.</p></li>
<li><p>Debug metadata is special in that it is currently dropped during upgrades.</p></li>
<li><p>Non-debug metadata is defined to be safe to drop, so a valid way to upgrade
it is to drop it. That is not very user friendly and a bit more effort is
expected, but no promises are made.</p></li>
</ul>
</div>
<div class="section" id="c-api-changes">
<h3><a class="toc-backref" href="#id22">C API Changes</a><a class="headerlink" href="#c-api-changes" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p>Stability Guarantees: The C API is, in general, a “best effort” for stability.
This means that we make every attempt to keep the C API stable, but that
stability will be limited by the abstractness of the interface and the
stability of the C++ API that it wraps. In practice, this means that things
like “create debug info” or “create this type of instruction” are likely to be
less stable than “take this IR file and JIT it for my current machine”.</p></li>
<li><p>Release stability: We won’t break the C API on the release branch with patches
that go on that branch, with the exception that we will fix an unintentional
C API break that will keep the release consistent with both the previous and
next release.</p></li>
<li><p>Testing: Patches to the C API are expected to come with tests just like any
other patch.</p></li>
<li><p>Including new things into the API: If an LLVM subcomponent has a C API already
included, then expanding that C API is acceptable. Adding C API for
subcomponents that don’t currently have one needs to be discussed on the
mailing list for design and maintainability feedback prior to implementation.</p></li>
<li><p>Documentation: Any changes to the C API are required to be documented in the
release notes so that it’s clear to external users who do not follow the
project how the C API is changing and evolving.</p></li>
</ul>
</div>
<div class="section" id="updating-toolchain-requirements">
<span id="toolchain"></span><h3><a class="toc-backref" href="#id23">Updating Toolchain Requirements</a><a class="headerlink" href="#updating-toolchain-requirements" title="Permalink to this headline">¶</a></h3>
<p>We intend to require newer toolchains as time goes by. This means LLVM’s
codebase can use newer versions of C++ as they get standardized. Requiring newer
toolchains to build LLVM can be painful for those building LLVM; therefore, it
will only be done through the following process:</p>
<blockquote>
<div><ul class="simple">
<li><p>It is a general goal to support LLVM and GCC versions from the last 3 years
at a minimum. This time-based guideline is not strict: we may support much
older compilers, or decide to support fewer versions.</p></li>
<li><p>An RFC is sent to the <a class="reference external" href="http://lists.llvm.org/mailman/listinfo/llvm-dev">llvm-dev mailing list</a></p>
<ul>
<li><p>Detail upsides of the version increase (e.g. which newer C++ language or
library features LLVM should use; avoid miscompiles in particular compiler
versions, etc).</p></li>
<li><p>Detail downsides on important platforms (e.g. Ubuntu LTS status).</p></li>
</ul>
</li>
<li><p>Once the RFC reaches consensus, update the CMake toolchain version checks as
well as the <a class="reference internal" href="GettingStarted.html"><span class="doc">getting started</span></a> guide. This provides a
softer transition path for developers compiling LLVM, because the
error can be turned into a warning using a CMake flag. This is an important
step: LLVM still doesn’t have code which requires the new toolchains, but it
soon will. If you compile LLVM but don’t read the mailing list, we should
tell you!</p></li>
<li><p>Ensure that at least one LLVM release has had this soft-error. Not all
developers compile LLVM top-of-tree. These release-bound developers should
also be told about upcoming changes.</p></li>
<li><p>Turn the soft-error into a hard-error after said LLVM release has branched.</p></li>
<li><p>Update the <a class="reference internal" href="CodingStandards.html"><span class="doc">coding standards</span></a> to allow the new
features we’ve explicitly approved in the RFC.</p></li>
<li><p>Start using the new features in LLVM’s codebase.</p></li>
</ul>
</div></blockquote>
<p>Here’s a <a class="reference external" href="http://lists.llvm.org/pipermail/llvm-dev/2019-January/129452.html">sample RFC</a> and the
<a class="reference external" href="https://reviews.llvm.org/D57264">corresponding change</a>.</p>
</div>
<div class="section" id="working-with-the-ci-system">
<span id="ci-usage"></span><h3><a class="toc-backref" href="#id24">Working with the CI system</a><a class="headerlink" href="#working-with-the-ci-system" title="Permalink to this headline">¶</a></h3>
<p>The main continuous integration (CI) tool for the LLVM project is the
<a class="reference external" href="https://lab.llvm.org/buildbot/">LLVM Buildbot</a>. It uses different <em>builders</em>
to cover a wide variety of sub-projects and configurations. The builds are
executed on different <em>workers</em>. Builders and workers are configured and
provided by community members.</p>
<p>The Buildbot tracks the commits on the main branch and the release branches.
This means that patches are built and tested after they are merged to the these
branches (aka post-merge testing). This also means it’s okay to break the build
occasionally, as it’s unreasonable to expect contributors to build and test
their patch with every possible configuration.</p>
<p><em>If your commit broke the build:</em></p>
<ul class="simple">
<li><p>Fix the build as soon as possible as this might block other contributors or
downstream users.</p></li>
<li><p>If you need more time to analyze and fix the bug, please revert your change to
unblock others.</p></li>
</ul>
<p><em>If someone else broke the build and this blocks your work</em></p>
<ul class="simple">
<li><p>Comment on the code review in <a class="reference external" href="https://reviews.llvm.org/">Phabricator</a>
(if available) or email the author, explain the problem and how this impacts
you. Add a link to the broken build and the error message so folks can
understand the problem.</p></li>
<li><p>Revert the commit if this blocks your work, see <a class="reference internal" href="#revert-policy">revert_policy</a> .</p></li>
</ul>
<p><em>If a build/worker is permanently broken</em></p>
<ul>
<li><p>1st step: contact the owner of the worker. You can find the name and contact
information for the <em>Admin</em> of worker on the page of the build in the
<em>Worker</em> tab:</p>
<img alt="_images/buildbot_worker_contact.png" src="_images/buildbot_worker_contact.png" />
</li>
<li><p>2nd step: If the owner does not respond or fix the worker, please escalate
to Galina Kostanova, the maintainer of the BuildBot master.</p></li>
<li><p>3rd step: If Galina could not help you, please escalate to the
<a class="reference external" href="mailto:iwg%40llvm.org">Infrastructure Working Group</a>.</p></li>
</ul>
</div>
</div>
<div class="section" id="introducing-new-components-into-llvm">
<span id="new-llvm-components"></span><h2><a class="toc-backref" href="#id25">Introducing New Components into LLVM</a><a class="headerlink" href="#introducing-new-components-into-llvm" title="Permalink to this headline">¶</a></h2>
<p>The LLVM community is a vibrant and exciting place to be, and we look to be
inclusive of new projects and foster new communities, and increase
collaboration across industry and academia.</p>
<p>That said, we need to strike a balance between being inclusive of new ideas and
people and the cost of ongoing maintenance that new code requires. As such, we
have a general <a class="reference internal" href="SupportPolicy.html"><span class="doc">support policy</span></a> for introducing major new
components into the LLVM world, depending on the degree of detail and
responsibility required. <em>Core</em> projects need a higher degree of scrutiny
than <em>peripheral</em> projects, and the latter may have additional differences.</p>
<p>However, this is really only intended to cover common cases
that we have seen arise: different situations are different, and we are open
to discussing unusual cases as well - just start an RFC thread on the
<a class="reference external" href="http://lists.llvm.org/mailman/listinfo/llvm-dev">llvm-dev mailing list</a>.</p>
<div class="section" id="adding-a-new-target">
<h3><a class="toc-backref" href="#id26">Adding a New Target</a><a class="headerlink" href="#adding-a-new-target" title="Permalink to this headline">¶</a></h3>
<p>LLVM is very receptive to new targets, even experimental ones, but a number of
problems can appear when adding new large portions of code, and back-ends are
normally added in bulk. New targets need the same level of support as other
<em>core</em> parts of the compiler, so they are covered in the <em>core tier</em> of our
<a class="reference internal" href="SupportPolicy.html"><span class="doc">support policy</span></a>.</p>
<p>We have found that landing large pieces of new code and then trying to fix
emergent problems in-tree is problematic for a variety of reasons. For these
reasons, new targets are <em>always</em> added as <em>experimental</em> until they can be
proven stable, and later moved to non-experimental.</p>
<p>The differences between both classes are:</p>
<ul class="simple">
<li><p>Experimental targets are not built by default (they need to be explicitly
enabled at CMake time).</p></li>
<li><p>Test failures, bugs, and build breakages that only appear when the
experimental target is enabled, caused by changes unrelated to the target, are
the responsibility of the community behind the target to fix.</p></li>
</ul>
<p>The basic rules for a back-end to be upstreamed in <strong>experimental</strong> mode are:</p>
<ul class="simple">
<li><p>Every target must have a <a class="reference internal" href="#code-owners"><span class="std std-ref">code owner</span></a>. The <cite>CODE_OWNERS.TXT</cite>
file has to be updated as part of the first merge. The code owner makes sure
that changes to the target get reviewed and steers the overall effort.</p></li>
<li><p>There must be an active community behind the target. This community
will help maintain the target by providing buildbots, fixing
bugs, answering the LLVM community’s questions and making sure the new
target doesn’t break any of the other targets, or generic code. This
behavior is expected to continue throughout the lifetime of the
target’s code.</p></li>
<li><p>The code must be free of contentious issues, for example, large
changes in how the IR behaves or should be formed by the front-ends,
unless agreed by the majority of the community via refactoring of the
(<a class="reference internal" href="LangRef.html"><span class="doc">IR standard</span></a>) <strong>before</strong> the merge of the new target changes,
following the <a class="reference internal" href="#ir-backwards-compatibility"><span class="std std-ref">IR Backwards Compatibility</span></a>.</p></li>
<li><p>The code conforms to all of the policies laid out in this developer policy
document, including license, patent, and coding standards.</p></li>
<li><p>The target should have either reasonable documentation on how it
works (ISA, ABI, etc.) or a publicly available simulator/hardware
(either free or cheap enough) - preferably both. This allows
developers to validate assumptions, understand constraints and review code
that can affect the target.</p></li>
</ul>
<p>In addition, the rules for a back-end to be promoted to <strong>official</strong> are:</p>
<ul class="simple">
<li><p>The target must have addressed every other minimum requirement and
have been stable in tree for at least 3 months. This cool down
period is to make sure that the back-end and the target community can
endure continuous upstream development for the foreseeable future.</p></li>
<li><p>The target’s code must have been completely adapted to this policy
as well as the <a class="reference internal" href="CodingStandards.html"><span class="doc">coding standards</span></a>. Any exceptions that
were made to move into experimental mode must have been fixed <strong>before</strong>
becoming official.</p></li>
<li><p>The test coverage needs to be broad and well written (small tests,
well documented). The build target <code class="docutils literal notranslate"><span class="pre">check-all</span></code> must pass with the
new target built, and where applicable, the <code class="docutils literal notranslate"><span class="pre">test-suite</span></code> must also
pass without errors, in at least one configuration (publicly
demonstrated, for example, via buildbots).</p></li>
<li><p>Public buildbots need to be created and actively maintained, unless
the target requires no additional buildbots (ex. <code class="docutils literal notranslate"><span class="pre">check-all</span></code> covers
all tests). The more relevant and public the new target’s CI infrastructure
is, the more the LLVM community will embrace it.</p></li>
</ul>
<p>To <strong>continue</strong> as a supported and official target:</p>
<ul class="simple">
<li><p>The maintainer(s) must continue following these rules throughout the lifetime
of the target. Continuous violations of aforementioned rules and policies
could lead to complete removal of the target from the code base.</p></li>
<li><p>Degradation in support, documentation or test coverage will make the target as
nuisance to other targets and be considered a candidate for deprecation and
ultimately removed.</p></li>
</ul>
<p>In essences, these rules are necessary for targets to gain and retain their
status, but also markers to define bit-rot, and will be used to clean up the
tree from unmaintained targets.</p>
</div>
<div class="section" id="adding-an-established-project-to-the-llvm-monorepo">
<h3><a class="toc-backref" href="#id27">Adding an Established Project To the LLVM Monorepo</a><a class="headerlink" href="#adding-an-established-project-to-the-llvm-monorepo" title="Permalink to this headline">¶</a></h3>
<p>The <a class="reference external" href="https://github.com/llvm/llvm-project">LLVM monorepo</a> is the centerpoint
of development in the LLVM world, and has all of the primary LLVM components,
including the LLVM optimizer and code generators, Clang, LLDB, etc. <a class="reference external" href="https://en.wikipedia.org/wiki/Monorepo">Monorepos
in general</a> are great because they
allow atomic commits to the project, simplify CI, and make it easier for
subcommunities to collaborate.</p>
<p>Like new targets, most projects already in the monorepo are considered to be in
the <em>core tier</em> of our <a class="reference internal" href="SupportPolicy.html"><span class="doc">support policy</span></a>. The burden to add
things to the LLVM monorepo needs to be very high - code that is added to this
repository is checked out by everyone in the community. As such, we hold
components to a high bar similar to “official targets”, they:</p>
<blockquote>
<div><ul class="simple">
<li><p>Must be generally aligned with the mission of the LLVM project to advance
compilers, languages, tools, runtimes, etc.</p></li>
<li><p>Must conform to all of the policies laid out in this developer policy
document, including license, patent, coding standards, and code of conduct.</p></li>
<li><p>Must have an active community that maintains the code, including established
code owners.</p></li>
<li><p>Should have reasonable documentation about how it works, including a high
quality README file.</p></li>
<li><p>Should have CI to catch breakage within the project itself or due to
underlying LLVM dependencies.</p></li>
<li><p>Should have code free of issues the community finds contentious, or be on a
clear path to resolving them.</p></li>
<li><p>Must be proposed through the LLVM RFC process, and have its addition approved
by the LLVM community - this ultimately mediates the resolution of the
“should” concerns above.</p></li>
</ul>
</div></blockquote>
<p>If you have a project that you think would make sense to add to the LLVM
monorepo, please start an RFC thread on the <a class="reference external" href="http://lists.llvm.org/mailman/listinfo/llvm-dev">llvm-dev mailing list</a> to kick off
the discussion. This process can take some time and iteration - please don’t
be discouraged or intimidated by that!</p>
<p>If you have an earlier stage project that you think is aligned with LLVM, please
see the “Incubating New Projects” section.</p>
</div>
<div class="section" id="incubating-new-projects">
<h3><a class="toc-backref" href="#id28">Incubating New Projects</a><a class="headerlink" href="#incubating-new-projects" title="Permalink to this headline">¶</a></h3>
<p>The burden to add a new project to the LLVM monorepo is intentionally very high,
but that can have a chilling effect on new and innovative projects. To help
foster these sorts of projects, LLVM supports an “incubator” process that is
much easier to get started with. It provides space for potentially valuable,
new top-level and sub-projects to reach a critical mass before they have enough
code to prove their utility and grow a community. This also allows
collaboration between teams that already have permissions to make contributions
to projects under the LLVM umbrella.</p>
<p>Projects which can be considered for the LLVM incubator meet the following
criteria:</p>
<blockquote>
<div><ul class="simple">
<li><p>Must be generally aligned with the mission of the LLVM project to advance
compilers, languages, tools, runtimes, etc.</p></li>
<li><p>Must conform to the license, patent, and code of conduct policies laid out
in this developer policy document.</p></li>
<li><p>Must have a documented charter and development plan, e.g. in the form of a
README file, mission statement, and/or manifesto.</p></li>
<li><p>Should conform to coding standards, incremental development process, and
other expectations.</p></li>
<li><p>Should have a sense of the community that it hopes to eventually foster, and
there should be interest from members with different affiliations /
organizations.</p></li>
<li><p>Should have a feasible path to eventually graduate as a dedicated top-level
or sub-project within the <a class="reference external" href="https://github.com/llvm/llvm-project">LLVM monorepo</a>.</p></li>
<li><p>Should include a notice (e.g. in the project README or web page) that the
project is in ‘incubation status’ and is not included in LLVM releases (see
suggested wording below).</p></li>
<li><p>Must be proposed through the LLVM RFC process, and have its addition
approved by the LLVM community - this ultimately mediates the resolution of
the “should” concerns above.</p></li>
</ul>
</div></blockquote>
<p>That said, the project need not have any code to get started, and need not have
an established community at all! Furthermore, incubating projects may pass
through transient states that violate the “Should” guidelines above, or would
otherwise make them unsuitable for direct inclusion in the monorepo (e.g.
dependencies that have not yet been factored appropriately, leveraging
experimental components or APIs that are not yet upstream, etc).</p>
<dl class="simple">
<dt>When approved, the llvm-admin group can grant the new project:</dt><dd><ul class="simple">
<li><p>A new repository in the LLVM Github Organization - but not the LLVM monorepo.</p></li>
<li><p>New mailing list, discourse forum, and/or discord chat hosted with other LLVM
forums.</p></li>
<li><p>Other infrastructure integration can be discussed on a case-by-case basis.</p></li>
</ul>
</dd>
</dl>
<p>Graduation to the mono-repo would follow existing processes and standards for
becoming a first-class part of the monorepo. Similarly, an incubating project
may be eventually retired, but no process has been established for that yet. If
and when this comes up, please start an RFC discussion on llvm-dev.</p>
<p>This process is very new - please expect the details to change, it is always
safe to ask on the <a class="reference external" href="http://lists.llvm.org/mailman/listinfo/llvm-dev">llvm-dev mailing list</a> about this.</p>
<p>Suggested disclaimer for the project README and the main project web page:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">This</span> <span class="n">project</span> <span class="ow">is</span> <span class="n">participating</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">LLVM</span> <span class="n">Incubator</span> <span class="n">process</span><span class="p">:</span> <span class="k">as</span> <span class="n">such</span><span class="p">,</span> <span class="n">it</span> <span class="ow">is</span>
<span class="ow">not</span> <span class="n">part</span> <span class="n">of</span> <span class="nb">any</span> <span class="n">official</span> <span class="n">LLVM</span> <span class="n">release</span><span class="o">.</span> <span class="n">While</span> <span class="n">incubation</span> <span class="n">status</span> <span class="ow">is</span> <span class="ow">not</span>
<span class="n">necessarily</span> <span class="n">a</span> <span class="n">reflection</span> <span class="n">of</span> <span class="n">the</span> <span class="n">completeness</span> <span class="ow">or</span> <span class="n">stability</span> <span class="n">of</span> <span class="n">the</span> <span class="n">code</span><span class="p">,</span> <span class="n">it</span>
<span class="n">does</span> <span class="n">indicate</span> <span class="n">that</span> <span class="n">the</span> <span class="n">project</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">yet</span> <span class="n">endorsed</span> <span class="k">as</span> <span class="n">a</span> <span class="n">component</span> <span class="n">of</span> <span class="n">LLVM</span><span class="o">.</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="copyright-license-and-patents">
<span id="copyright-license-patents"></span><h2><a class="toc-backref" href="#id29">Copyright, License, and Patents</a><a class="headerlink" href="#copyright-license-and-patents" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This section deals with legal matters but does not provide legal advice. We
are not lawyers — please seek legal counsel from a licensed attorney.</p>
</div>
<p>This section addresses the issues of copyright, license and patents for the LLVM
project. The copyright for the code is held by the contributors of
the code. The code is licensed under permissive <a class="reference internal" href="#open-source-licensing-terms">open source licensing terms</a>,
namely the Apache-2.0 with LLVM-exception license, which includes a copyright
and <a class="reference internal" href="#patent-license">patent license</a>. When you contribute code to the LLVM project, you
license it under these terms.</p>
<p>If you have questions or comments about these topics, please contact the
<a class="reference external" href="mailto:llvm-dev%40lists.llvm.org">LLVM Developer’s Mailing List</a>. However,
please realize that most compiler developers are not lawyers, and therefore you
will not be getting official legal advice.</p>
<div class="section" id="copyright">
<h3><a class="toc-backref" href="#id30">Copyright</a><a class="headerlink" href="#copyright" title="Permalink to this headline">¶</a></h3>
<p>The LLVM project does not collect copyright assignments, which means that the
copyright for the code in the project is held by the respective contributors.
Because you (or your company)
retain ownership of the code you contribute, you know it may only be used under
the terms of the open source license you contributed it under: the license for
your contributions cannot be changed in the future without your approval.</p>
<p>Because the LLVM project does not require copyright assignments, changing the
LLVM license requires tracking down the
contributors to LLVM and getting them to agree that a license change is
acceptable for their contributions. We feel that a high burden for relicensing
is good for the project, because contributors do not have to fear that their
code will be used in a way with which they disagree.</p>
</div>
<div class="section" id="relicensing">
<h3><a class="toc-backref" href="#id31">Relicensing</a><a class="headerlink" href="#relicensing" title="Permalink to this headline">¶</a></h3>
<p>The last paragraph notwithstanding, the LLVM Project is in the middle of a large
effort to change licenses, which aims to solve several problems:</p>
<ul class="simple">
<li><p>The old licenses made it difficult to move code from (e.g.) the compiler to
runtime libraries, because runtime libraries used a different license from the
rest of the compiler.</p></li>
<li><p>Some contributions were not submitted to LLVM due to concerns that
the patent grant required by the project was overly broad.</p></li>
<li><p>The patent grant was unique to the LLVM Project, not written by a lawyer, and
was difficult to determine what protection was provided (if any).</p></li>
</ul>
<p>The scope of relicensing is all code that is considered part of the LLVM
project, including the main LLVM repository, runtime libraries (compiler_rt,
OpenMP, etc), Polly, and all other subprojects. There are a few exceptions:</p>
<ul class="simple">
<li><p>Code imported from other projects (e.g. Google Test, Autoconf, etc) will
remain as it is. This code isn’t developed as part of the LLVM project, it
is used by LLVM.</p></li>
<li><p>Some subprojects are impractical or uninteresting to relicense (e.g. llvm-gcc
and dragonegg). These will be split off from the LLVM project (e.g. to
separate GitHub projects), allowing interested people to continue their
development elsewhere.</p></li>
</ul>
<p>To relicense LLVM, we will be seeking approval from all of the copyright holders
of code in the repository, or potentially remove/rewrite code if we cannot.
This is a large
and challenging project which will take a significant amount of time to
complete. In the interim, <strong>all contributions to the project will be made under
the terms of both the new license and the legacy license scheme</strong> (each of which
is described below). The exception to this is the legacy patent grant, which
will not be required for new contributions.</p>
<p>When all of the code in the project has been converted to the new license or
removed, we will drop the requirement to contribute under the legacy license.
This will achieve the goal of having
a single standardized license for the entire codebase.</p>
<p>If you are a prior contributor to LLVM and have not done so already, please do
<em>TODO</em> to allow us to use your code. <em>Add a link to a separate page here, which
is probably a click through web form or something like that. Details to be
determined later</em>.</p>
</div>
<div class="section" id="new-llvm-project-license-framework">
<span id="open-source-licensing-terms"></span><h3><a class="toc-backref" href="#id32">New LLVM Project License Framework</a><a class="headerlink" href="#new-llvm-project-license-framework" title="Permalink to this headline">¶</a></h3>
<p>Contributions to LLVM are licensed under the <a class="reference external" href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>, with two limited
exceptions intended to ensure that LLVM is very permissively licensed.
Collectively, the name of this license is “Apache 2.0 License with LLVM
exceptions”. The exceptions read:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">----</span> <span class="n">LLVM</span> <span class="n">Exceptions</span> <span class="n">to</span> <span class="n">the</span> <span class="n">Apache</span> <span class="mf">2.0</span> <span class="n">License</span> <span class="o">----</span>
<span class="n">As</span> <span class="n">an</span> <span class="n">exception</span><span class="p">,</span> <span class="k">if</span><span class="p">,</span> <span class="k">as</span> <span class="n">a</span> <span class="n">result</span> <span class="n">of</span> <span class="n">your</span> <span class="n">compiling</span> <span class="n">your</span> <span class="n">source</span> <span class="n">code</span><span class="p">,</span> <span class="n">portions</span>
<span class="n">of</span> <span class="n">this</span> <span class="n">Software</span> <span class="n">are</span> <span class="n">embedded</span> <span class="n">into</span> <span class="n">an</span> <span class="n">Object</span> <span class="n">form</span> <span class="n">of</span> <span class="n">such</span> <span class="n">source</span> <span class="n">code</span><span class="p">,</span> <span class="n">you</span>
<span class="n">may</span> <span class="n">redistribute</span> <span class="n">such</span> <span class="n">embedded</span> <span class="n">portions</span> <span class="ow">in</span> <span class="n">such</span> <span class="n">Object</span> <span class="n">form</span> <span class="n">without</span> <span class="n">complying</span>
<span class="k">with</span> <span class="n">the</span> <span class="n">conditions</span> <span class="n">of</span> <span class="n">Sections</span> <span class="mi">4</span><span class="p">(</span><span class="n">a</span><span class="p">),</span> <span class="mi">4</span><span class="p">(</span><span class="n">b</span><span class="p">)</span> <span class="ow">and</span> <span class="mi">4</span><span class="p">(</span><span class="n">d</span><span class="p">)</span> <span class="n">of</span> <span class="n">the</span> <span class="n">License</span><span class="o">.</span>
<span class="n">In</span> <span class="n">addition</span><span class="p">,</span> <span class="k">if</span> <span class="n">you</span> <span class="n">combine</span> <span class="ow">or</span> <span class="n">link</span> <span class="n">compiled</span> <span class="n">forms</span> <span class="n">of</span> <span class="n">this</span> <span class="n">Software</span> <span class="k">with</span>
<span class="n">software</span> <span class="n">that</span> <span class="ow">is</span> <span class="n">licensed</span> <span class="n">under</span> <span class="n">the</span> <span class="n">GPLv2</span> <span class="p">(</span><span class="s2">"Combined Software"</span><span class="p">)</span> <span class="ow">and</span> <span class="k">if</span> <span class="n">a</span>
<span class="n">court</span> <span class="n">of</span> <span class="n">competent</span> <span class="n">jurisdiction</span> <span class="n">determines</span> <span class="n">that</span> <span class="n">the</span> <span class="n">patent</span> <span class="n">provision</span> <span class="p">(</span><span class="n">Section</span>
<span class="mi">3</span><span class="p">),</span> <span class="n">the</span> <span class="n">indemnity</span> <span class="n">provision</span> <span class="p">(</span><span class="n">Section</span> <span class="mi">9</span><span class="p">)</span> <span class="ow">or</span> <span class="n">other</span> <span class="n">Section</span> <span class="n">of</span> <span class="n">the</span> <span class="n">License</span>
<span class="n">conflicts</span> <span class="k">with</span> <span class="n">the</span> <span class="n">conditions</span> <span class="n">of</span> <span class="n">the</span> <span class="n">GPLv2</span><span class="p">,</span> <span class="n">you</span> <span class="n">may</span> <span class="n">retroactively</span> <span class="ow">and</span>
<span class="n">prospectively</span> <span class="n">choose</span> <span class="n">to</span> <span class="n">deem</span> <span class="n">waived</span> <span class="ow">or</span> <span class="n">otherwise</span> <span class="n">exclude</span> <span class="n">such</span> <span class="n">Section</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="n">of</span>
<span class="n">the</span> <span class="n">License</span><span class="p">,</span> <span class="n">but</span> <span class="n">only</span> <span class="ow">in</span> <span class="n">their</span> <span class="n">entirety</span> <span class="ow">and</span> <span class="n">only</span> <span class="k">with</span> <span class="n">respect</span> <span class="n">to</span> <span class="n">the</span> <span class="n">Combined</span>
<span class="n">Software</span><span class="o">.</span>
</pre></div>
</div>
<p>We intend to keep LLVM perpetually open source and available under a permissive
license - this fosters the widest adoption of LLVM by
<strong>allowing commercial products to be derived from LLVM</strong> with few restrictions
and without a requirement for making any derived works also open source. In
particular, LLVM’s license is not a “copyleft” license like the GPL.</p>
<p>The “Apache 2.0 License with LLVM exceptions” allows you to:</p>
<ul class="simple">
<li><p>freely download and use LLVM (in whole or in part) for personal, internal, or
commercial purposes.</p></li>
<li><p>include LLVM in packages or distributions you create.</p></li>
<li><p>combine LLVM with code licensed under every other major open source
license (including BSD, MIT, GPLv2, GPLv3…).</p></li>
<li><p>make changes to LLVM code without being required to contribute it back
to the project - contributions are appreciated though!</p></li>
</ul>
<p>However, it imposes these limitations on you:</p>
<ul class="simple">
<li><p>You must retain the copyright notice if you redistribute LLVM: You cannot
strip the copyright headers off or replace them with your own.</p></li>
<li><p>Binaries that include LLVM must reproduce the copyright notice (e.g. in an
included README file or in an “About” box), unless the LLVM code was added as
a by-product of compilation. For example, if an LLVM runtime library like
compiler_rt or libc++ was automatically included into your application by the
compiler, you do not need to attribute it.</p></li>
<li><p>You can’t use our names to promote your products (LLVM derived or not) -
though you can make truthful statements about your use of the LLVM code,
without implying our sponsorship.</p></li>
<li><p>There’s no warranty on LLVM at all.</p></li>
</ul>
<p>We want LLVM code to be widely used, and believe that this provides a model that
is great for contributors and users of the project. For more information about
the Apache 2.0 License, please see the <a class="reference external" href="http://www.apache.org/foundation/license-faq.html">Apache License FAQ</a>, maintained by the
Apache Project.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The LLVM Project includes some really old subprojects (dragonegg,
llvm-gcc-4.0, and llvm-gcc-4.2), which are licensed under <strong>GPL
licenses</strong>. This code is not actively maintained - it does not even
build successfully. This code is cleanly separated into distinct SVN
repositories from the rest of LLVM, and the LICENSE.txt files specifically
indicate that they contain GPL code. When LLVM transitions from SVN to Git,
we plan to drop these code bases from the new repository structure.</p>
</div>
</div>
<div class="section" id="patents">
<span id="patent-license"></span><h3><a class="toc-backref" href="#id33">Patents</a><a class="headerlink" href="#patents" title="Permalink to this headline">¶</a></h3>
<p>Section 3 of the Apache 2.0 license is a patent grant under which
contributors of code to the project contribute the rights to use any of
their patents that would otherwise be infringed by that code contribution
(protecting uses of that code). Further, the patent grant is revoked
from anyone who files a patent lawsuit about code in LLVM - this protects the
community by providing a “patent commons” for the code base and reducing the
odds of patent lawsuits in general.</p>
<p>The license specifically scopes which patents are included with code
contributions. To help explain this, the <a class="reference external" href="http://www.apache.org/foundation/license-faq.html">Apache License FAQ</a> explains this scope using
some questions and answers, which we reproduce here for your convenience (for
reference, the “ASF” is the Apache Software Foundation, the guidance still
holds though):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>Q1: If I own a patent and contribute to a Work, and, at the time my
contribution is included in that Work, none of my patent's claims are subject
to Apache's Grant of Patent License, is there a way any of those claims would
later become subject to the Grant of Patent License solely due to subsequent
contributions by other parties who are not licensees of that patent.
A1: No.
Q2: If at any time after my contribution, I am able to license other patent
claims that would have been subject to Apache's Grant of Patent License if
they were licensable by me at the time of my contribution, do those other
claims become subject to the Grant of Patent License?
A2: Yes.
Q3: If I own or control a licensable patent and contribute code to a specific
Apache product, which of my patent claims are subject to Apache's Grant of
Patent License?
A3: The only patent claims that are licensed to the ASF are those you own or
have the right to license that read on your contribution or on the
combination of your contribution with the specific Apache product to which
you contributed as it existed at the time of your contribution. No additional
patent claims become licensed as a result of subsequent combinations of your
contribution with any other software. Note, however, that licensable patent
claims include those that you acquire in the future, as long as they read on
your original contribution as made at the original time. Once a patent claim
is subject to Apache's Grant of Patent License, it is licensed under the
terms of that Grant to the ASF and to recipients of any software distributed
by the ASF for any Apache software product whatsoever.
</pre></div>
</div>
</div>
<div class="section" id="legacy-license-structure">
<span id="legacy"></span><h3><a class="toc-backref" href="#id34">Legacy License Structure</a><a class="headerlink" href="#legacy-license-structure" title="Permalink to this headline">¶</a></h3>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The code base was previously licensed under the Terms described here.
We are in the middle of relicensing to a new approach (described above), but
until this effort is complete, the code is also still available under these
terms. Once we finish the relicensing project, new versions of the code will
not be available under these terms. However, nothing takes away your right
to use old versions under the licensing terms under which they were
originally released.</p>
</div>
<p>We intend to keep LLVM perpetually open source and to use a permissive open
source license. The code in
LLVM is available under the <a class="reference external" href="http://www.opensource.org/licenses/UoI-NCSA.php">University of Illinois/NCSA Open Source License</a>, which boils down to
this:</p>
<ul class="simple">
<li><p>You can freely distribute LLVM.</p></li>
<li><p>You must retain the copyright notice if you redistribute LLVM.</p></li>
<li><p>Binaries derived from LLVM must reproduce the copyright notice (e.g. in an
included README file).</p></li>
<li><p>You can’t use our names to promote your LLVM derived products.</p></li>
<li><p>There’s no warranty on LLVM at all.</p></li>
</ul>
<p>We believe this fosters the widest adoption of LLVM because it <strong>allows
commercial products to be derived from LLVM</strong> with few restrictions and without
a requirement for making any derived works also open source (i.e. LLVM’s
license is not a “copyleft” license like the GPL). We suggest that you read the
<a class="reference external" href="http://www.opensource.org/licenses/UoI-NCSA.php">License</a> if further
clarification is needed.</p>
<p>In addition to the UIUC license, the runtime library components of LLVM
(<strong>compiler_rt, libc++, and libclc</strong>) are also licensed under the <a class="reference external" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a>, which does not contain
the binary redistribution clause. As a user of these runtime libraries, it
means that you can choose to use the code under either license (and thus don’t
need the binary redistribution clause), and as a contributor to the code that
you agree that any contributions to these libraries be licensed under both
licenses. We feel that this is important for runtime libraries, because they
are implicitly linked into applications and therefore should not subject those
applications to the binary redistribution clause. This also means that it is ok
to move code from (e.g.) libc++ to the LLVM core without concern, but that code
cannot be moved from the LLVM core to libc++ without the copyright owner’s
permission.</p>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="CodeReview.html" title="LLVM Code-Review Policy and Practices"
>next</a> |</li>
<li class="right" >
<a href="Contributing.html" title="Contributing to LLVM"
>previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="GettingInvolved.html" >Getting Involved</a> »</li>
<li class="nav-item nav-item-this"><a href="">LLVM Developer Policy</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2003-2021, LLVM Project.
Last updated on 2021-09-18.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
</div>
</body>
</html>
|
