l4/pkg/libstdc++-v3/contrib/libstdc++-v3-4.7/doc/html/manual/appendix_contributing.html

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