OLD | NEW |
| (Empty) |
1 <?xml version="1.0" encoding="UTF-8" standalone="no"?> | |
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.or
g/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
3 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type"
content="text/html; charset=UTF-8" /><title>Appendix A. Contributing</title><m
eta name="generator" content="DocBook XSL Stylesheets V1.74.0" /><meta name="key
words" content=" ISO C++ , library " /><lin
k rel="home" href="../spine.html" title="The GNU C++ Library Documentation" /><l
ink rel="up" href="spine.html" title="The GNU C++ Library" /><link rel="prev" hr
ef="bk01pt12ch40s03.html" title="Use" /><link rel="next" href="source_organizati
on.html" title="Directory Layout and Source Conventions" /></head><body><div cla
ss="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="
3" align="center">Appendix A. | |
4 Contributing | |
5 | |
6 </th></tr><tr><td width="20%" align="left"><a accesskey="p" href="bk01pt12ch40s0
3.html">Prev</a> </td><th width="60%" align="center">The GNU C++ Library</th><td
width="20%" align="right"> <a accesskey="n" href="source_organization.html">Nex
t</a></td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"
><div class="titlepage"><div><div><h2 class="title"><a id="appendix.contrib"></a
>Appendix A. | |
7 Contributing | |
8 <a id="id495630" class="indexterm"></a> | |
9 </h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><
span class="sect1"><a href="appendix_contributing.html#contrib.list">Contributor
Checklist</a></span></dt><dd><dl><dt><span class="sect2"><a href="appendix_cont
ributing.html#list.reading">Reading</a></span></dt><dt><span class="sect2"><a hr
ef="appendix_contributing.html#list.copyright">Assignment</a></span></dt><dt><sp
an class="sect2"><a href="appendix_contributing.html#list.getting">Getting Sourc
es</a></span></dt><dt><span class="sect2"><a href="appendix_contributing.html#li
st.patches">Submitting Patches</a></span></dt></dl></dd><dt><span class="sect1">
<a href="source_organization.html">Directory Layout and Source Conventions</a></
span></dt><dt><span class="sect1"><a href="source_code_style.html">Coding Style<
/a></span></dt><dd><dl><dt><span class="sect2"><a href="source_code_style.html#c
oding_style.bad_identifiers">Bad Identifiers</a></span></dt><dt><span class="sec
t2"><a href="source_code_style.html#coding_style.example">By Example</a></span><
/dt></dl></dd><dt><span class="sect1"><a href="documentation_style.html">Documen
tation Style</a></span></dt><dd><dl><dt><span class="sect2"><a href="documentati
on_style.html#doc_style.doxygen">Doxygen</a></span></dt><dt><span class="sect2">
<a href="documentation_style.html#doc_style.docbook">Docbook</a></span></dt></dl
></dd><dt><span class="sect1"><a href="source_design_notes.html">Design Notes</a
></span></dt></dl></div><p> | |
10 The GNU C++ Library follows an open development model. Active | |
11 contributors are assigned maintainer-ship responsibility, and given | |
12 write access to the source repository. First time contributors | |
13 should follow this procedure: | |
14 </p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div>
<h2 class="title" style="clear: both"><a id="contrib.list"></a>Contributor Check
list</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class
="titlepage"><div><div><h3 class="title"><a id="list.reading"></a>Reading</h3></
div></div></div><div class="itemizedlist"><ul type="disc"><li><p> | |
15 Get and read the relevant sections of the C++ language | |
16 specification. Copies of the full ISO 14882 standard are | |
17 available on line via the ISO mirror site for committee | |
18 members. Non-members, or those who have not paid for the | |
19 privilege of sitting on the committee and sustained their | |
20 two meeting commitment for voting rights, may get a copy of | |
21 the standard from their respective national standards | |
22 organization. In the USA, this national standards | |
23 organization is ANSI and their web-site is right | |
24 <a class="ulink" href="http://www.ansi.org" target="_top">here.</a> | |
25 (And if you've already registered with them, clicking this link will t
ake you to directly to the place where you can | |
26 <a class="ulink" href="http://webstore.ansi.org/ansidocstore/product.a
sp?sku=ISO%2FIEC+14882%3A2003" target="_top">buy the standard on-line.)</a> | |
27 </p></li><li><p> | |
28 The library working group bugs, and known defects, can | |
29 be obtained here: | |
30 <a class="ulink" href="http://www.open-std.org/jtc1/sc22/wg21/" target
="_top">http://www.open-std.org/jtc1/sc22/wg21 </a> | |
31 </p></li><li><p> | |
32 The newsgroup dedicated to standardization issues is | |
33 comp.std.c++: this FAQ for this group is quite useful and | |
34 can be | |
35 found <a class="ulink" href="http://www.jamesd.demon.co.uk/csc/faq.htm
l" target="_top"> | |
36 here </a>. | |
37 </p></li><li><p> | |
38 Peruse | |
39 the <a class="ulink" href="http://www.gnu.org/prep/standards_toc.html"
target="_top">GNU | |
40 Coding Standards</a>, and chuckle when you hit the part | |
41 about “<span class="quote">Using Languages Other Than C</span>”. | |
42 </p></li><li><p> | |
43 Be familiar with the extensions that preceded these | |
44 general GNU rules. These style issues for libstdc++ can be | |
45 found <a class="link" href="source_code_style.html" title="Coding Styl
e">here</a>. | |
46 </p></li><li><p> | |
47 And last but certainly not least, read the | |
48 library-specific information | |
49 found <a class="link" href="appendix_porting.html" title="Appendix B.
Porting and Maintenance"> here</a>. | |
50 </p></li></ul></div></div><div class="sect2" lang="en" xml:lang="en"><div
class="titlepage"><div><div><h3 class="title"><a id="list.copyright"></a>Assignm
ent</h3></div></div></div><p> | |
51 Small changes can be accepted without a copyright assignment form on | |
52 file. New code and additions to the library need completed copyright | |
53 assignment form on file at the FSF. Note: your employer may be required | |
54 to fill out appropriate disclaimer forms as well. | |
55 </p><p> | |
56 Historically, the libstdc++ assignment form added the following | |
57 question: | |
58 </p><p> | |
59 “<span class="quote"> | |
60 Which Belgian comic book character is better, Tintin or Asterix, and | |
61 why? | |
62 </span>” | |
63 </p><p> | |
64 While not strictly necessary, humoring the maintainers and answering | |
65 this question would be appreciated. | |
66 </p><p> | |
67 For more information about getting a copyright assignment, please see | |
68 <a class="ulink" href="http://www.gnu.org/prep/maintain/html_node/Legal-Ma
tters.html" target="_top">Legal | |
69 Matters</a>. | |
70 </p><p> | |
71 Please contact Benjamin Kosnik at | |
72 <code class="email"><<a class="email" href="mailto:bkoz+assign@redhat.c
om">bkoz+assign@redhat.com</a>></code> if you are confused | |
73 about the assignment or have general licensing questions. When | |
74 requesting an assignment form from | |
75 <code class="email"><<a class="email" href="mailto:mailto:assign@gnu.or
g">mailto:assign@gnu.org</a>></code>, please cc the libstdc++ | |
76 maintainer above so that progress can be monitored. | |
77 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage">
<div><div><h3 class="title"><a id="list.getting"></a>Getting Sources</h3></div><
/div></div><p> | |
78 <a class="ulink" href="http://gcc.gnu.org/svnwrite.html" target="_top">Get
ting write access | |
79 (look for "Write after approval")</a> | |
80 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage">
<div><div><h3 class="title"><a id="list.patches"></a>Submitting Patches</h3></di
v></div></div><p> | |
81 Every patch must have several pieces of information before it can be | |
82 properly evaluated. Ideally (and to ensure the fastest possible | |
83 response from the maintainers) it would have all of these pieces: | |
84 </p><div class="itemizedlist"><ul type="disc"><li><p> | |
85 A description of the bug and how your patch fixes this | |
86 bug. For new features a description of the feature and your | |
87 implementation. | |
88 </p></li><li><p> | |
89 A ChangeLog entry as plain text; see the various | |
90 ChangeLog files for format and content. If using you are | |
91 using emacs as your editor, simply position the insertion | |
92 point at the beginning of your change and hit CX-4a to bring | |
93 up the appropriate ChangeLog entry. See--magic! Similar | |
94 functionality also exists for vi. | |
95 </p></li><li><p> | |
96 A testsuite submission or sample program that will | |
97 easily and simply show the existing error or test new | |
98 functionality. | |
99 </p></li><li><p> | |
100 The patch itself. If you are accessing the SVN | |
101 repository use <span class="command"><strong>svn update; svn diff NEW<
/strong></span>; | |
102 else, use <span class="command"><strong>diff -cp OLD NEW</strong></spa
n> ... If your | |
103 version of diff does not support these options, then get the | |
104 latest version of GNU | |
105 diff. The <a class="ulink" href="http://gcc.gnu.org/wiki/SvnTricks" ta
rget="_top">SVN | |
106 Tricks</a> wiki page has information on customising the | |
107 output of <code class="code">svn diff</code>. | |
108 </p></li><li><p> | |
109 When you have all these pieces, bundle them up in a | |
110 mail message and send it to libstdc++@gcc.gnu.org. All | |
111 patches and related discussion should be sent to the | |
112 libstdc++ mailing list. | |
113 </p></li></ul></div></div></div></div><div class="navfooter"><hr /><tabl
e width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a a
ccesskey="p" href="bk01pt12ch40s03.html">Prev</a> </td><td width="20%" align="ce
nter"><a accesskey="u" href="spine.html">Up</a></td><td width="40%" align="right
"> <a accesskey="n" href="source_organization.html">Next</a></td></tr><tr><td wi
dth="40%" align="left" valign="top">Use </td><td width="20%" align="center"><a a
ccesskey="h" href="../spine.html">Home</a></td><td width="40%" align="right" val
ign="top"> Directory Layout and Source Conventions</td></tr></table></div></body
></html> | |
OLD | NEW |