2003-06-24 Benjamin Kosnik <bkoz@redhat.com>
+
+ * docs/html/documentation.html: Remove assignment info.
+ * docs/html/17_intro/contribute.html: Edits.
+ * docs/html/17_intro/libstdc++-assign.tx: Remove.
+
+ * docs/html/test.html: Update.
+
+ * README: Update.
+
+2003-06-24 Benjamin Kosnik <bkoz@redhat.com>
Ulrich Drepper <drepper@redhat.com>
* testsuite/testsuite_performance.h: Tweak mallinfo.
Headers that define extensions to the standard library. No
standard header refers to any of them.
+ scripts
+ Scripts that are used during the configure, build, make, or test
+ process.
+
src
Files that are used in constructing the library, but are not
installed.
- testsuites/[thread, 17_* to 27_*]
+ testsuites/[backward, demangle, ext, performance, thread, 17_* to 27_*]
Test programs are here, and may be used to begin to exercise the
library. Support for "make check" and "make check-install" is
complete, and runs through all the subdirectories here when this
that are meant to be copied or linked by the configure script.
Currently these are:
+ config/abi
config/cpu
- config/os
config/io
config/locale
+ config/os
In addition, three subdirectories are convenience libraries:
- libio
- Contains the subset of the GNU libio library needed for
- C++. Currently not used.
-
libmath
Support routines needed for C++ math. Only needed if the
underlying "C" implementation is non-existent, in particular
<!-- #include virtual="/include/header-subpages.html"-->
<body>
<h2>How to contribute</h2>
-<p>
-The Standard C++ Library v3, or libstc++-2.90.x, follows an open development model. Active contributors are assigned maintainer-ship responsibility, and given write access to the CVS repository. First time submitors and all other potential contributors should follow this procedure:
+<p> The Standard C++ Library v3, follows an open development
+model. Active contributors are assigned maintainer-ship
+responsibility, and given write access to the CVS repository. First
+time contributors should follow this procedure:
</p>
<hr />
<a href="http://webstore.ansi.org/ansidocstore/product.asp?sku=ISO%2FIEC+14882%2D1998">buy the standard on-line.)</a>
</li>
-<li> The library working group bugs, and known defects, can be obtained at these web sites:
+<li> The library working group bugs, and known defects, can be obtained here:
<a href="http://www.dkuug.dk/jtc1/sc22/wg21/">http://www.dkuug.dk/jtc1/sc22/wg21 </a>
- and <a href="http://www.comeaucomputing.com/iso/">http://www.comeaucomputing.com/iso/</a>
</li>
<li> The newsgroup dedicated to standardization issues is comp.std.c++: this FAQ for this group is quite useful and can be found <a href="http://reality.sgi.com/austern_mti/std-c++/faq.html"> here </a>.
Small changes can be accepted without a copyright assignment form on
file. New code and additions to the library need completed copyright
assignment form on file at the FSF. Note: your employer may be required
-to fill out appropriate disclaimer forms as well. Here is the <a href="libstdc++-assign.txt"> form. </a>
+to fill out appropriate disclaimer forms as well.
+</p>
+
+<p> Historically, the libstdc++ assignment form added the following question:
+</p>
-Please contact <a href="mailto:benjamin@cygnus.com">Benjamin
+<code>[Which Belgian comic book character is better, Tintin or
+Asterix, and why?]</code>
+
+<p>
+While not strictly necessary, humoring the maintainers and answering
+this question would be appreciated.
+</p>
+
+<p>
+For more information about getting a copyright assignment, please see
+<a href=http://www.gnu.org/prep/maintain_4.html#SEC4=> Legal Issues</a>
+</p>
+
+<p>
+Please contact <a href="mailto:bkoz+assign@redhat.com">Benjamin
Kosnik</a> if you are confused about the assignment or have general
-licensing questions.
+licensing questions. When requesting an assignment form from <a
+HREF="mailto:assign@gnu.org">assign@gnu.org</a>, please cc
+the above libstdc++ maintainer so that progress can be monitored.
</p>
<li> A description of the bug and how your patch fixes this bug. For
new features a description of the feature and your implementation. </li>
- <li> A ChangeLog entry as plaintext; see the various ChangeLog files
+ <li> A ChangeLog entry as plain text; see the various ChangeLog files
for format and content. If using you are using emacs as your editor,
simply position the insertion point at the beginning of your change
and hit CX-4a to bring up the appropriate ChangeLog
<li> When you have all these pieces, bundle them up in a mail message
and send it to libstdc++@gcc.gnu.org. All patches and related
-discussion should be sent to the libstdc++ mailinglist. </li>
+discussion should be sent to the libstdc++ mailing list. </li>
</ul>
+++ /dev/null
-The way to assign copyright to the Free Software Foundation is to sign
-an assignment contract. This is what legally makes the Free Software
-Foundation the copyright holder so that we can register the copyright
-on the new version. I'm assuming that you wrote these changes
-yourself; if other people wrote parts, we may need papers from them.
-
-If you are employed to do programming (even at a university), or have
-made an agreement with your employer or school saying it owns programs
-you write, then you and we need a signed piece of paper from your
-employer disclaiming rights to the program.
-
-The disclaimer should be signed by a vice president or general manager
-of the company. If you can't get at them, anyone else authorized to
-license software produced there will do. Here is a sample wording:
-
- Digital Stimulation Corporation hereby disclaims all copyright interest
- in the changes and enhancements made by Hugh Heffner to the program
- "libstdc++", also including any future revisions of these changes and
- enhancements.
-
- Digital Stimulation Corporation affirms that it has no other
- intellectual property interest that would undermine this release, or
- the use of the Program, and will do nothing to undermine it in the
- future.
-
- <signature of Ty Coon>, 1 April 1987
- Ty Coon, President of Vice, Digital Stimulation Corp.
-
-(If your employer says they do have an intellectual property claim
-that could conflict with the use of the program, then please put me in
-touch with a suitable representative of the company, so that we can
-negotiate what to do about it.)
-
-IMPORTANT: When you talk to your employer, *no matter what
-instructions they have given you*, don't fail to show them the sample
-disclaimer above, or a disclaimer with the details filled in for your
-specific case. Companies are usually willing to sign a disclaimer
-without any fuss. If you make your request less specific, you may
-open Pandora's box and cause a long and unnecessary delay.
-
-Below is the assignment contract that we usually use. You need
-to print it out, sign it, and snail it to:
-
-Copyright Clerk
-c/o Free Software Foundation
-59 Temple Place - Suite 330
-Boston, MA 02111-1307, USA
-
-Please try to print the whole first page below on a single piece of
-paper. If it doesn't fit on one printed page, put it on two sides of
-a single piece of paper.
-
-Don't forget to put down the date when you sign! Spell out the month
-name--don't use a number for the month. Dates using a number for the
-month are ambiguous; 2/8/95 means one thing in the US and another in
-Europe.
-
-Snail a copy of the employer's disclaimer as well.
-
-Please send me email about what you decide to do. If you have any
-questions, or would like something to be changed, ask bkoz@gnu.org via
-email.
-\f ASSIGNMENT
-
- For good and valuable consideration, receipt of which I
-acknowledge, I, [your name here], hereby transfer to the Free Software
-Foundation, Inc. (the "Foundation") my entire right, title, and
-interest (including all rights under copyright) in my changes and
-enhancements to the libstdc++ library, subject to the conditions
-below. These changes and enhancements are herein called the "Work".
-The work hereby assigned shall also include any future revisions of
-these changes and enhancements hereafter made by me.
-
- Upon thirty days' prior written notice, the "Foundation" agrees to
-grant me non-exclusive rights to use the Work (i.e. my changes and
-enhancements, not the program which I enhanced) as I see fit; (and
-the "Foundation"'s rights shall otherwise continue unchanged).
-
- I hereby agree that if I have or acquire hereafter any patent or
-interface copyright or other intellectual property interest dominating
-the program enhanced by the Work (or use of that program), such
-dominating interest will not be used to undermine the effect of this
-assignment, i.e. the "Foundation" and the general public will be
-licensed to use, in that program and its derivative works, without
-royalty or limitation, the subject matter of the dominating interest.
-This license provision will be binding on my heirs, assignees, or
-other successors to the dominating interest, as well as on me.
-
- I hereby represent and warrant that I am the sole copyright holder
-for the Work and that I have the right and power to enter into this
-contract. I hereby indemnify and hold harmless the "Foundation", its
-officers, employees, and agents against any and all claims, actions or
-damages (including attorney's reasonable fees) asserted by or paid to
-any party on account of a breach or alleged breach of the foregoing
-warranty. I make no other express or implied warranty (including
-without limitation, in this disclaimer of warranty, any warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE).
-
-Agreed: [signature] Date [Write the month with LETTERS]:
-
-
-For the "Foundation",
-Richard Stallman, head dude in charge
-\f
-Please do not delete the control-l character before this line.
-Please print this as a separate page.
-
-Please email a copy of the information on this page to
-fsf-records@gnu.ai.mit.edu, and cc bkoz@gnu.org, if you can, so that
-our clerk doesn't have to type it in. Use your full name as the
-subject line.
-
-[For the copyright registration, what country are you a citizen of?
-What year were you born?]
-
-
-[Please write your email address here.]
-
-
-[Please write your snail address here, so we can snail a copy back to you.]
-
-
-
-[Which files have you changed so far, and which new files have you written
-so far?]
-
-
-[Which Belgian comic book character is better, Tintin or Asterix, and why?]
-
<h2><a name="5">Contributor-Specific Information</a></h2>
<ul>
<li><a href="17_intro/contribute.html">Contributor checklist</a></li>
- <li><a href="17_intro/libstdc++-assign.txt">Copyright assignment form for libstdc++-v3</a></li>
<li><a href="http://gcc.gnu.org/cvswrite.html">Getting CVS write access
(look for "Write after approval")</a></li>
<li><a href="17_intro/BADNAMES">BADNAMES</a>
specific file name. This indicates a test that is used to
analyze runtime performance, for performance regression testing,
or for other optimization related analysis. At the moment, these
- test cases are not run by default, and instead assumed to be run
- manually.
+ test cases are not run by default.
</p>
</li>
</ul>
<p></p>
</li>
<li>
+ <em>testsuite_performance.h</em>
+ <p>
+ A number of class abstractions for performance counters, and
+ reporting functions including:
+ </p>
+ <ul>
+ <li>time_counter</li>
+ <li>resource_counter</li>
+ <li>report_performance</li>
+ </ul>
+ <p></p>
+ </li>
+ <li>
<em>printnow.c</em>
<p>
A cross-platform timer for use in one of the older harnesses
<p> In addition, there are some testing options that are mostly of
interest to library maintainers and system integrators. As such,
these tests may not work on all cpu and host combinations, and must
- be executed in the <em>libbuilddir</em> directory. These options
+ be executed in the <em>libbuilddir/testsuite</em> directory. These options
include, but are not necessarily limited to, the following:
</p>
<pre>
make check-abi</pre>
<p>The library ABI can be tested. This involves testing the shared
- library against an ABI-defining previous version.</p>
+ library against an ABI-defining previous version. </p>
+
+ <pre>
+ make check-performance</pre>
+ <p>This rule runs through the <em>testsuite_files_performance</em>
+ test cases and collects information for performance analysis and
+ can be used to spot performance regressions. Various timing
+ information is collected, as well as number of hard page faults,
+ and memory used. This is not run by default, and the implementation
+ is in flux.
+</p>
<p>
We are interested in any strange failures of the