Tighten requirements on filenames, add review manager duties, reorganize a bit

[SVN r9977]

more/formal_review_process.htm

@@ -39,7 +39,7 @@ comments:</p>
 <blockquote>
   <ul>
     <li>Publicly on the mailing list.</li>
-    <li>Privately to the Review Manager. (See Formal Review Status page )</li>
+    <li>Privately to the Review Manager.</li>
     <li>Privately to the library submitter.</li>
   </ul>
 </blockquote>
@@ -82,6 +82,11 @@ connected with the library submission must volunteer to be the &quot;Review
 Manager&quot; for the library.</p>
 <p>The review manager:</p>
 <ul>
+  <li>Checks the submission to make sure it really is complete enough to warrant
+    formal review.&nbsp; See the <a href="lib_guide.htm">Boost Library
+    Requirements and Guidelines</a>.&nbsp; If necessary, work with the submitter
+    to verify the code compiles and runs correctly on several compilers and
+    platforms.</li>
   <li>Sets the schedule, after discussion with the boost webmaster, currently
     Beman Dawes.&nbsp;</li>
   <li>Posts a notice of the review schedule on both the regular boost mailing
@@ -108,7 +113,7 @@ submission file</a> sent to the webmaster for posting.&nbsp; If the suggested
 changes might affect reviewer's judgments,&nbsp; post a notice of the pending
 change on the mailing list.</p>
 <hr>
-<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->23 April, 2001<!--webbot bot="Timestamp" endspan i-checksum="29812" --></p>
+<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->24 April, 2001<!--webbot bot="Timestamp" endspan i-checksum="29814" --></p>
 <p>&nbsp;</p>
 
 </body>

more/lib_guide.htm

@@ -85,7 +85,9 @@ embarrassingly.</p>
     <p align="left">A library's implementation must if possible be portable and
     not restricted to a particular compiler or operating system.&nbsp; If a
     portable implementation is not possible, non-portable constructions are
-    acceptable if reasonably easy to port to other environments.
+    acceptable if reasonably easy to port to other environments, and
+    implementations are provided for at least two popular operating systems
+    (such as UNIX and Windows).
   </li>
   <li>
     <p align="left">There is no requirement that a library run on C++ compilers
@@ -194,8 +196,12 @@ library, but a reasonable effort to comply is expected.</p>
     </ul>
   </li>
 </ul>
-<h3><a name="Directory structure">Directory Structure</a></h3>
+<h3><a name="Directory structure">Directory Structure</a> and Filenames</h3>
 <ul>
+  <li>File and directory names must contain only lowercase ASCII letters ,
+    numbers, underscores, and a period.&nbsp; Leading character must be
+    alphabetic. Maximum length 31. Only a single period is permitted.&nbsp;
+    These requirements ensure file and directory names are relatively portable.</li>
   <li>All libraries have at their highest level a primary directory named for
     the particular library. The primary directory may have sub-directories.</li>
   <li>For very simple libraries implemented entirely within the library header,
@@ -339,7 +345,7 @@ suggestion.&nbsp; Major contributions are usually acknowledged in the
 documentation, while minor fixes are often mentioned in comments within the code
 itself.</p>
 <hr>
-<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->17 April, 2001<!--webbot bot="Timestamp" endspan i-checksum="29819" --></p>
+<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->24 April, 2001<!--webbot bot="Timestamp" endspan i-checksum="29814" --></p>
 
 </body>
 

more/submission_process.htm

@@ -31,8 +31,10 @@ page for issues of content.</p>
   <li><a href="#interest">Determine interest</a>.</li>
   <li><a href="#Preliminary">Preliminary submission</a>.</li>
   <li><a href="#Refinement">Refinement</a>.</li>
+  <li><a href="#Submission">Submission for review</a>.</li>
   <li><a href="#Review">Formal Review</a>.</li>
   <li><a href="#site posting">Web site posting</a>.</li>
+  <li><a href="#People">People page.</a></li>
   <li><a href="#Lifecycle">Lifecycle</a>.</li>
 </ul>
 <h2><a name="Learn">Learn</a> about Boost</h2>
@@ -57,9 +59,9 @@ list, and no attachments, even small ones.&nbsp; Please post lengthy material in
 the eGroups boost <a href="http://www.egroups.com/files/boost/">Files section</a>
 (formerly called the &quot; vault&quot;).&nbsp;</p>
 <h2><a name="Preliminary">Preliminary</a> submission</h2>
-<p>If response to an initial query indicates interest, then post preliminary
-files in the <a href="http://www.egroups.com/files/boost/">Files section</a> of
-the boost eGroups web site if you haven't already done so.</p>
+<p>If response to an initial query indicates interest, then post the preliminary
+submission files in the <a href="http://www.egroups.com/files/boost/">files section</a> of
+the Boost eGroups web site if you haven't already done so.</p>
 <h2><a name="Refinement">Refinement</a></h2>
 <p>Discuss, refine, resubmit.&nbsp; Repeat until satisfied.</p>
 <p>The exact details of this process varies a lot.&nbsp; Sometimes it is public,
@@ -69,9 +71,22 @@ on for months.&nbsp; It's often challenging, and sometimes leads off in
 completely unexpected directions.&nbsp;&nbsp;</p>
 <p>The <a href="http://www.egroups.com/messages/boost">archive</a> of past
 messages is one way to see how this process worked for other boost
-libraries.&nbsp;</p>
+libraries.</p>
+<h2><a name="Submission">Submission</a> for review&nbsp;</h2>
+<p>All of the files which make up the library should be combined and compressed
+into a single submission file using the .zip format.&nbsp; Free encoders
+and decoders for this format running on many different platforms are available
+at the <a href="http://www.info-zip.org/pub/infozip/">Info-ZIP</a> web site, which
+includes a FAQ and much other useful information about the .zip format. Many
+commercial compressor-archiver utilities also support this format.</p>
+<p>The submission file should contain material as if on the
+boost.org web site.&nbsp; The closer the submission file mirrors the final <a href="lib_guide.htm#Directory structure">directory
+structure</a> and format of the web site, the better.
+<p>Like a preliminary submission, post the final submission .zip file in the <a href="http://www.egroups.com/files/boost/">files section</a> of
+the Boost eGroups web site
 <h2>Formal <a name="Review">Review</a></h2>
-<p>Before asking for formal review, please verify that your submission compiles
+<p>Before asking for formal review, your submission should be posted in the
+Boost files/vault. Please verify that your submission compiles
 and runs under at least two compilers.&nbsp; This flushes out obvious
 portability problems.&nbsp; If you don't have access to a second compiler, ask
 for help on the Boost mailing list.</p>
@@ -83,67 +98,19 @@ the library name.</p>
 <p>See <a href="formal_review_process.htm">Formal Review Process</a> for
 details.</p>
 <p>Formal Review schedules are posted on the boost mailing list..&nbsp;</p>
-<h2>Boost <a name="site posting">site posting</a></h2>
+<h2>Boost <a name="site posting">site posting</a> after acceptance</h2>
 <p>There are two ways that files are posted on the boost web site:</p>
 <ul>
   <li>Direct update of the boost CVS repository.&nbsp; This requires write
     access, and is primarily used for larger libraries, or for libraries
     maintained by very active boost developers.</li>
-  <li>Packaging all files into submission file, and emailing it to the boost
-    webmaster.</li>
+  <li>Packaging all files into a submission file (same content as for submission
+    for review), and emailing it to the Boost webmaster <a href="mailto:bdawes@acm.org">bdawes@acm.org</a>.</li>
 </ul>
-<p>The submission file approach is as follows:</p>
-<h3>Packaging</h3>
-<p>All of the files which make up the library should be combined and compressed
-into a single final submission file using the .zip format.&nbsp; Free encoders
-and decoders for this format running on many different platforms are available
-at the <a href="http://www.info-zip.org/pub/infozip/">Info-ZIP</a> web site, which
-includes a FAQ and much other useful information about the .zip format. Many
-commercial compressor-archiver utilities also support this format.</p>
-<h3><a name="Final">Final</a> Submission file</h3>
-<p>The final submission file contains the material that will live on the
-boost.org web site.&nbsp; The closer the submission file mirrors the directory
-structure and format of the web site, the easier it is for the webmaster to
-integrate it into the web site.
-<p>The submission file for a library named <b>foo</b> should include these
-subdirectories, with the contents indicated:
-<blockquote>
-  <p><b>libs/foo</b>
-  <ul>
-    <li>An introductory page named index.html or index.htm which looks like the
-      initial page of other libraries. <a href="../libs/rational/index.html">Rational</a>&nbsp;
-      is a model for single part libraries, <a href="../libs/integer/index.htm">Integer</a>
-      is a model for
-      multi-part libraries.</li>
-    <li>The documentation page or pages, also in HTML format.</li>
-    <li>Source files implementing the library if it isn't entirely header
-      based.&nbsp; The boost file type convention for source files is <b>.cpp</b>.</li>
-    <li>Test programs and data files if supplied.</li>
-    <li>If the library has a large number of subsidiary files which aren't
-      linked to from the documentation pages, these subsidiary files can be
-      combined into a single .zip file.</li>
-  </ul>
-  <p><b>boost</b></p>
-  <ul>
-    <li>Public header files as described in the documentation for the
-      library.&nbsp; The boost file type convention for header files is <b>.hpp</b>.</li>
-  </ul>
-  <p><b>boost/detail</b></p>
-  <ul>
-    <li>Implementation header files not normally accessed by library users.</li>
-  </ul>
-</blockquote>
-<h3>Transmission</h3>
-<p>Submit via email to <a href="mailto:bdawes@acm.org">bdawes@acm.org</a>.&nbsp;&nbsp;
-Attach the .zip submission file.&nbsp; In the email message, please include your
-email address, postal mail address, and telephone number, if boost.org doesn't
-already have them. Your addresses and phone number will not appear on the web
-site (unless you include them in your biography).&nbsp; Anonymous postings are
-not accepted.</p>
-<h3>People pages</h3>
+<h2><a name="People">People</a> page</h2>
 <p>If the boost.org web site doesn't already have your capsule biography
 and&nbsp; picture (optional, with not-too-serious pictures preferred), please
-send them <a href="mailto:bdawes@acm.org">mailto:bdawes@acm.org</a>. It is
+send them to the Boost webmaster.. It is
 up to you as to whether or not the biography includes your email address or
 other contact information.&nbsp; The preferred picture format is .jpg, but other
 common formats are acceptable.&nbsp; The preferred image size is 500x375 but the
@@ -153,7 +120,7 @@ necessary.</p>
 <p>Libraries are software; they loose their value over time if not
 maintained.&nbsp; Details still hazy.</p>
 <hr>
-<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10 March, 2001<!--webbot bot="Timestamp" endspan i-checksum="28765" --></p>
+<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->24 April, 2001<!--webbot bot="Timestamp" endspan i-checksum="29814" --></p>
 
 </body>