diff --git a/lib_guide.htm b/lib_guide.htm index 54ff7a2..f5ad8e3 100644 --- a/lib_guide.htm +++ b/lib_guide.htm @@ -3,7 +3,7 @@ Boost Library Requirements and Guidelines - + @@ -21,6 +21,25 @@

Boost Library Requirements and Guidelines

+

Introduction
+Requirements
+    License requirements
+    Portability requirements
+    Ownership
+Guidelines
+    Design and programming
+    Directory structure and +filenames
+    Naming consistency
+    Documentation
+Rationale
+    Exception-specification +rationale
+    Naming conventions rationale
+    Source code fonts rationale
+    Rationale rationale
+    Acknowledgements rationale

+

Introduction

This page describes requirements and guidelines for the content of a library submitted to Boost.

See the Boost Library @@ -116,7 +135,7 @@ Press, 1990 says:

your employer in advance.

Place a copyright notice in all the important files you submit. -Boost.org won't accept libraries without clear copyright information.

+Boost won't accept libraries without clear copyright information.

Guidelines

Please use these guidelines as a checklist for preparing the content a library submission.  Not every guideline applies to every @@ -133,7 +152,7 @@ library, but a reasonable effort to comply is expected.

If you need more help with how to write documentation you can check out the article on Writing Documentation for Boost.

-

Rationale

+

Rationale

Rationale for some of the requirements and guidelines follows.


Exception-specification rationale

@@ -332,7 +385,7 @@ reasonably well when viewed with a variable-width font, and as far as I can tell every editor supporting variable-width fonts also supports fixed width. I don't think the converse is true.


-

Rationale rationale

+

Rationale rationale

Rationale is defined as "The fundamental reasons for something; basis." by the American Heritage Dictionary.

Beman Dawes comments:  Failure to supply contemporaneous rationale for @@ -351,8 +404,8 @@ suggestion.  Major contributions are usually acknowledged in the documentation, while minor fixes are often mentioned in comments within the code itself.


-

Revised 02 November, 2001

+

Revised 15 August, 2002

- + \ No newline at end of file