[Boost-commit] svn:boost r40982 - website/public_html/beta/development

From: daniel_james_at_[hidden]
Date: 2007-11-10 09:05:11

Author: danieljames
Date: 2007-11-10 09:05:10 EST (Sat, 10 Nov 2007)
New Revision: 40982
URL: http://svn.boost.org/trac/boost/changeset/40982

Log:
Update the Boost Library Requirements and Guidelines. Refs #1357.

The links still need work.

Text files modified: 
   website/public_html/beta/development/requirements.html |    80 ++++++++++++++++------------------------
   1 files changed, 32 insertions(+), 48 deletions(-)

Modified: website/public_html/beta/development/requirements.html
==============================================================================
--- website/public_html/beta/development/requirements.html	(original)
+++ website/public_html/beta/development/requirements.html	2007-11-10 09:05:10 EST (Sat, 10 Nov 2007)
@@ -243,8 +243,8 @@
               Standard Library where applicable.</p>
 
               <p>Headers should be good neighbors. See the <a href=
-              "header.htm">header policy</a>. See <a href=
-              "#Naming%C2%AD_consistency">Naming consistency</a>.</p>
+              "header.html">header policy</a>. See <a href=
+              "#Naming_consistency">Naming consistency</a>.</p>
 
               <p>Follow quality programming practices. See, for example,
               "Effective C++" 2nd Edition, and "More Effective C++", both by
@@ -253,7 +253,7 @@
               <p>Use the C++ Standard Library or other Boost libraries, but
               only when the benefits outweigh the costs. Do not use libraries
               other than the C++ Standard Library or Boost. See <a href=
-              "library_reuse.htm">Library reuse</a>.</p>
+              "library_reuse.html">Library reuse</a>.</p>
 
               <p>Read Implementation Variation to
               see how to supply performance, platform, or other
@@ -296,7 +296,7 @@
               users can see how to use your library.</p>
 
               <p>Provide a regression test program or programs which follow
-              the <a href="test_policy.htm">Test Policies and
+              the <a href="test_policy.html">Test Policies and
               Protocols</a>.</p>
 
               <p>Although some boost members use proportional fonts, tabs,
@@ -316,39 +316,23 @@
 
               <p>End all documentation files (HTML or otherwise) with a
               copyright message and a licensing message. See the <a href=
-              "#Copyright">end of this file</a> for an example of the
+              "/users/license.html">license information</a> page for the
               preferred form.</p>
 
               <p>Begin all source files (including programs, headers,
               scripts, etc.) with:</p>
 
               <ul>
-                <li>A comment line describing the contents of the
-                file.<br /></li>
+                <li>A comment line describing the contents of the file.</li>
 
-                <li>Comments describing copyright and licensing. The
-                preferred form is:
-                  <pre>
-// Copyright Jane Programmer 2002. Use, modification, and distribution are
-// subject to the Boost Software License, Version 1.0. (See accompanying
-// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-</pre>
-
-                  <p>Please leave an empty line before and after the
-                  copyright and license comments. It is fine if the copyright
-                  and license messages are on different lines, but there
-                  should be no other intervening text. Do not include "All
-                  rights reserved" in the copyright message.</p>
-
-                  <p>See <a href="license_info.html">license information
-                  page</a> for more information about the Boost Software
-                  License.</p>
-
-                  <p>Note that developers should not include a copy of
-                  <code>LICENSE_1_0.txt</code> in their libraries; Boost
-                  distributions already include a copy in the Boost root
-                  directory.</p>
-                </li>
+                <li>Comments describing copyright and licensing: again, the
+                preferred form is indicated in the <a href=
+                "/users/license.html">license information</a> page</li>
+
+                <li>Note that developers should not provide a copy of
+                <code>LICENSE_1_0.txt</code> with their libraries: Boost
+                distributions already include a copy in the Boost root
+                directory.</li>
 
                 <li>A comment line referencing your library on the Boost web
                 site. For example:
@@ -357,7 +341,7 @@
 </pre>
 
                   <p>Where <code>foo</code> is the directory name (see below)
-                  for your library. As well as aiding users who come across a
+                  for the library. As well as aiding users who come across a
                   Boost file detached from its documentation, some of Boost's
                   automatic tools depend on this comment to identify which
                   library header files belong to.</p>
@@ -415,7 +399,7 @@
                 is true regardless if the function is a free (namespace
                 scope) function, a member function or a static member
                 function, and it applies for the function declaration as well
-                as the function definition.</li>
+                as for the function definition.</li>
               </ul>
 
               <h3><a name="Directory_structure" id=
@@ -424,21 +408,21 @@
 
               <ul>
                 <li>File and directory names must contain only
-                <b>lowercase</b> ASCII letters , numbers, underscores, and a
+                <b>lowercase</b> ASCII letters, numbers, underscores, and a
                 period. Leading character must be alphabetic. Maximum length
                 31. Only a single period is permitted. These requirements
                 ensure file and directory names are relatively portable.</li>
 
                 <li>Files intended to be processed by a C++ compiler as part
-                of a translation unit should have <b>a three-letter extension
-                ending in "pp"</b>. Other files should <i>not</i> use
-                extensions ending in "pp". This convention makes it easy to
-                identify all of the C++ source in Boost.</li>
+                of a translation unit should have <b>a three-letter filename
+                extension ending in "pp"</b>. Other files should <i>not</i>
+                use extensions ending in "pp". This convention makes it easy
+                to identify all of the C++ source in Boost.</li>
 
                 <li>All libraries have at their highest level a primary
                 directory named for the particular library. See <a href=
-                "#Naming%C2%AD_consistency">Naming consistency</a>. The
-                primary directory may have sub-directories.</li>
+                "#Naming_consistency">Naming consistency</a>. The primary
+                directory may have sub-directories.</li>
 
                 <li>For very simple libraries implemented entirely within the
                 library header, all files go in the primary directory (except
@@ -735,21 +719,21 @@
               <p>Tabs are banned because of the practical problems caused by
               tabs in multi-developer projects like Boost, rather than any
               dislike in principle. See <a href=
-              "mailing_lists.htm#archive">mailing list archives</a>. Problems
-              include maintenance of a single source file by programmers
-              using tabs and programmers using spaces, and the difficulty of
-              enforcing a consistent tab policy other than just "no tabs".
-              Discussions concluded that Boost files should either all use
-              tabs, or all use spaces, and thus the decision to stick with
-              spaces.</p>
+              "/community/groups.html#archive">mailing list archives</a>.
+              Problems include maintenance of a single source file by
+              programmers using tabs and programmers using spaces, and the
+              difficulty of enforcing a consistent tab policy other than just
+              "no tabs". Discussions concluded that Boost files should either
+              all use tabs, or all use spaces, and thus the decision to stick
+              with spaces.</p>
 
               <h3><a name="JavaScript" id=
               "JavaScript"></a>ECMAScript/JavaScript rationale</h3>
 
               <p>Before the 1.29.0 release, two Boost libraries added
               ECMAScript/JavaScript documentation. Controversy followed (see
-              mailing list archives),
-              and the developers were asked to remove the
+              <a href="/community/groups.html#archive">mailing list
+              archives</a>), and the developers were asked to remove the
               ECMAScript/JavaScript. Reasons given for banning included:</p>
 
               <ul>