feedc0de/boost_config
1
0
Fork 0
forked from boostorg/config
Code Pull Requests Activity

Fixed a couple of typos.

Browse Source 
[SVN r45813]
This commit is contained in:
John Maddock
2008-05-27 16:09:09 +00:00
parent cb26255e3c
commit 6c321feebf
3 changed files with 16 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/guidelines.qbk
View File

@ -87,8 +87,8 @@ Currently it disables the following warnings:
[section Adding New Defect Macros] [section Adding New Defect Macros]
When you need to add a new defect macro -either to fix a problem with an When you need to add a new defect macro - either to fix a problem with an
existing library, or when adding a new library- distil the issue down to existing library, or when adding a new library - distil the issue down to
a simple test case; often, at this point other (possibly better) workarounds a simple test case; often, at this point other (possibly better) workarounds
may become apparent. Secondly always post the test case code to the boost may become apparent. Secondly always post the test case code to the boost
mailing list and invite comments; remember that C++ is complex and that mailing list and invite comments; remember that C++ is complex and that
@ -107,7 +107,7 @@ place the test case in a `.ipp` file with the following comments near the top:
These comments are processed by the autoconf script, so make sure the format These comments are processed by the autoconf script, so make sure the format
follows the one given. The file should be named "`boost_no_foo.ipp`", where foo follows the one given. The file should be named "`boost_no_foo.ipp`", where foo
is the defect description -try and keep the file name under the Mac 30 character is the defect description - try and keep the file name under the Mac 30 character
filename limit though. You will also need to provide a function prototype filename limit though. You will also need to provide a function prototype
"`int test()`" that is declared in a namespace with the same name as the macro, "`int test()`" that is declared in a namespace with the same name as the macro,
but in all lower case, and which returns zero on success: but in all lower case, and which returns zero on success:
@ -133,7 +133,7 @@ libs/config/test/all/Jamfile.v2, `config_test.cpp` and `config_info.cpp`.
['MACRONAME] is the name of the new macro, and `compiler-list` is the list of ['MACRONAME] is the name of the new macro, and `compiler-list` is the list of
compilers to test with. You should see the tests pass with those compilers compilers to test with. You should see the tests pass with those compilers
that don't have the defect, and fail with those that do. that don't have the defect, and fail with those that do.
* cd into `libs/config/test` and `run bjam config_info config_test compiler-list` : * cd into `libs/config/test` and run `bjam config_info config_test compiler-list` :
`config_info` should build and run cleanly for all the compilers in `compiler-list` `config_info` should build and run cleanly for all the compilers in `compiler-list`
while `config_test` should fail for those that have the defect, and pass for those while `config_test` should fail for those that have the defect, and pass for those
that do not. that do not.
@ -194,7 +194,7 @@ are included by default and should change only if support for a new
compiler/standard library/platform is added. compiler/standard library/platform is added.
The compiler/platform/standard library selection code is set up so that unknown The compiler/platform/standard library selection code is set up so that unknown
platforms are ignored and assumed to be fully standards compliant -this gives platforms are ignored and assumed to be fully standards compliant - this gives
unknown platforms a "sporting chance" of working "as is" even without running unknown platforms a "sporting chance" of working "as is" even without running
the configure script. the configure script.

21
doc/html/boost_config/guidelines_for_boost_authors.html
View File

@ -188,8 +188,8 @@
New Defect Macros</a> New Defect Macros</a>
</h3></div></div></div> </h3></div></div></div>
<p> <p>
When you need to add a new defect macro -either to fix a problem with an When you need to add a new defect macro - either to fix a problem with an
existing library, or when adding a new library- distil the issue down to existing library, or when adding a new library - distil the issue down to
a simple test case; often, at this point other (possibly better) workarounds a simple test case; often, at this point other (possibly better) workarounds
may become apparent. Secondly always post the test case code to the boost may become apparent. Secondly always post the test case code to the boost
mailing list and invite comments; remember that C++ is complex and that sometimes mailing list and invite comments; remember that C++ is complex and that sometimes
@ -213,7 +213,7 @@
<p> <p>
These comments are processed by the autoconf script, so make sure the format These comments are processed by the autoconf script, so make sure the format
follows the one given. The file should be named "<code class="computeroutput"><span class="identifier">boost_no_foo</span><span class="special">.</span><span class="identifier">ipp</span></code>", follows the one given. The file should be named "<code class="computeroutput"><span class="identifier">boost_no_foo</span><span class="special">.</span><span class="identifier">ipp</span></code>",
where foo is the defect description -try and keep the file name under the where foo is the defect description - try and keep the file name under the
Mac 30 character filename limit though. You will also need to provide a function Mac 30 character filename limit though. You will also need to provide a function
prototype "<code class="computeroutput"><span class="keyword">int</span> <span class="identifier">test</span><span class="special">()</span></code>" that is declared in a namespace with prototype "<code class="computeroutput"><span class="keyword">int</span> <span class="identifier">test</span><span class="special">()</span></code>" that is declared in a namespace with
the same name as the macro, but in all lower case, and which returns zero the same name as the macro, but in all lower case, and which returns zero
@ -250,11 +250,10 @@
the defect, and fail with those that do. the defect, and fail with those that do.
</li> </li>
<li> <li>
cd into <code class="computeroutput"><span class="identifier">libs</span><span class="special">/</span><span class="identifier">config</span><span class="special">/</span><span class="identifier">test</span></code> and <code class="computeroutput"><span class="identifier">run</span> cd into <code class="computeroutput"><span class="identifier">libs</span><span class="special">/</span><span class="identifier">config</span><span class="special">/</span><span class="identifier">test</span></code> and run <code class="computeroutput"><span class="identifier">bjam</span>
<span class="identifier">bjam</span> <span class="identifier">config_info</span> <span class="identifier">config_info</span> <span class="identifier">config_test</span>
<span class="identifier">config_test</span> <span class="identifier">compiler</span><span class="special">-</span><span class="identifier">list</span></code> <span class="identifier">compiler</span><span class="special">-</span><span class="identifier">list</span></code> : <code class="computeroutput"><span class="identifier">config_info</span></code>
: <code class="computeroutput"><span class="identifier">config_info</span></code> should build should build and run cleanly for all the compilers in <code class="computeroutput"><span class="identifier">compiler</span><span class="special">-</span><span class="identifier">list</span></code>
and run cleanly for all the compilers in <code class="computeroutput"><span class="identifier">compiler</span><span class="special">-</span><span class="identifier">list</span></code>
while <code class="computeroutput"><span class="identifier">config_test</span></code> should while <code class="computeroutput"><span class="identifier">config_test</span></code> should
fail for those that have the defect, and pass for those that do not. fail for those that have the defect, and pass for those that do not.
</li> </li>
@ -343,9 +342,9 @@
</p> </p>
<p> <p>
The compiler/platform/standard library selection code is set up so that unknown The compiler/platform/standard library selection code is set up so that unknown
platforms are ignored and assumed to be fully standards compliant -this gives platforms are ignored and assumed to be fully standards compliant - this
unknown platforms a "sporting chance" of working "as is" gives unknown platforms a "sporting chance" of working "as
even without running the configure script. is" even without running the configure script.
</p> </p>
<p> <p>
When adding or modifying the individual mini-configs, assume that future, When adding or modifying the individual mini-configs, assume that future,

2
doc/html/index.html
View File

@ -960,7 +960,7 @@
</p> </p>
</div> </div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><p><small>Last revised: May 27, 2008 at 12:08:04 GMT</small></p></td> <td align="left"><p><small>Last revised: May 27, 2008 at 16:07:04 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td> <td align="right"><div class="copyright-footer"></div></td>
</tr></table> </tr></table>
<hr> <hr>