forked from boostorg/config
Added docs for new warning_disable.hpp header.
[SVN r44620]
This commit is contained in:
@@ -59,6 +59,32 @@ at that.
|
|||||||
majority of compilers, such as namespaces, exceptions, RTTI, or templates.
|
majority of compilers, such as namespaces, exceptions, RTTI, or templates.
|
||||||
|
|
||||||
|
|
||||||
|
[section:warnings Disabling Compiler Warings]
|
||||||
|
|
||||||
|
The header `<boost/config/warning_disable.hpp>` can be used to disable
|
||||||
|
certain compiler warings that are hard or impossible to otherwise remove.
|
||||||
|
|
||||||
|
Note that:
|
||||||
|
|
||||||
|
* This header [*['should never be included by another Boost header]], it should
|
||||||
|
only ever be used by a library source file or a test case.
|
||||||
|
* The header should be included [*['before you include any other header]].
|
||||||
|
* This header only disables warnings that are hard or impossible to otherwise
|
||||||
|
deal with, and which are typically emitted by one compiler only, or
|
||||||
|
in one compilers own standard library headers.
|
||||||
|
|
||||||
|
Currently it disables the following warnings:
|
||||||
|
|
||||||
|
[table
|
||||||
|
[[Compiler][Warning]]
|
||||||
|
[[Visual C++ 8 and later][[@http://msdn2.microsoft.com/en-us/library/ttcz0bys(VS.80).aspx C4996]: Error 'function': was declared deprecated]]
|
||||||
|
[[Intel C++][Warning 1786: relates to the use of "deprecated" standard
|
||||||
|
library functions rather like C4996 in Visual C++.]]
|
||||||
|
]
|
||||||
|
|
||||||
|
[endsect]
|
||||||
|
|
||||||
|
|
||||||
[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
|
||||||
|
@@ -28,6 +28,8 @@
|
|||||||
Boost Authors</a>
|
Boost Authors</a>
|
||||||
</h2></div></div></div>
|
</h2></div></div></div>
|
||||||
<div class="toc"><dl>
|
<div class="toc"><dl>
|
||||||
|
<dt><span class="section"><a href="guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.warnings">
|
||||||
|
Disabling Compiler Warings</a></span></dt>
|
||||||
<dt><span class="section"><a href="guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_defect_macros">Adding
|
<dt><span class="section"><a href="guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_defect_macros">Adding
|
||||||
New Defect Macros</a></span></dt>
|
New Defect Macros</a></span></dt>
|
||||||
<dt><span class="section"><a href="guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_feature_test_macros">Adding
|
<dt><span class="section"><a href="guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_feature_test_macros">Adding
|
||||||
@@ -103,6 +105,85 @@
|
|||||||
</ul></div>
|
</ul></div>
|
||||||
<div class="section" lang="en">
|
<div class="section" lang="en">
|
||||||
<div class="titlepage"><div><div><h3 class="title">
|
<div class="titlepage"><div><div><h3 class="title">
|
||||||
|
<a name="boost_config.guidelines_for_boost_authors.warnings"></a><a href="guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.warnings" title="Disabling Compiler Warings">
|
||||||
|
Disabling Compiler Warings</a>
|
||||||
|
</h3></div></div></div>
|
||||||
|
<p>
|
||||||
|
The header <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">config</span><span class="special">/</span><span class="identifier">warning_disable</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
|
||||||
|
can be used to disable certain compiler warings that are hard or impossible
|
||||||
|
to otherwise remove.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Note that:
|
||||||
|
</p>
|
||||||
|
<div class="itemizedlist"><ul type="disc">
|
||||||
|
<li>
|
||||||
|
This header <span class="bold"><strong><span class="emphasis"><em>should never be included by
|
||||||
|
another Boost header</em></span></strong></span>, it should only ever be used
|
||||||
|
by a library source file or a test case.
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
The header should be included <span class="bold"><strong><span class="emphasis"><em>before you
|
||||||
|
include any other header</em></span></strong></span>.
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
This header only disables warnings that are hard or impossible to otherwise
|
||||||
|
deal with, and which are typically emitted by one compiler only, or in
|
||||||
|
one compilers own standard library headers.
|
||||||
|
</li>
|
||||||
|
</ul></div>
|
||||||
|
<p>
|
||||||
|
Currently it disables the following warnings:
|
||||||
|
</p>
|
||||||
|
<div class="informaltable"><table class="table">
|
||||||
|
<colgroup>
|
||||||
|
<col>
|
||||||
|
<col>
|
||||||
|
</colgroup>
|
||||||
|
<thead><tr>
|
||||||
|
<th>
|
||||||
|
<p>
|
||||||
|
Compiler
|
||||||
|
</p>
|
||||||
|
</th>
|
||||||
|
<th>
|
||||||
|
<p>
|
||||||
|
Warning
|
||||||
|
</p>
|
||||||
|
</th>
|
||||||
|
</tr></thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<p>
|
||||||
|
Visual C++ 8 and later
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>
|
||||||
|
<a href="http://msdn2.microsoft.com/en-us/library/ttcz0bys(VS.80).aspx" target="_top">C4996</a>:
|
||||||
|
Error 'function': was declared deprecated
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
<p>
|
||||||
|
Intel C++
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>
|
||||||
|
Warning 1786: relates to the use of "deprecated" standard
|
||||||
|
library functions rather like C4996 in Visual C++.
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table></div>
|
||||||
|
</div>
|
||||||
|
<div class="section" lang="en">
|
||||||
|
<div class="titlepage"><div><div><h3 class="title">
|
||||||
<a name="boost_config.guidelines_for_boost_authors.adding_new_defect_macros"></a><a href="guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_defect_macros" title="Adding New Defect Macros">Adding
|
<a name="boost_config.guidelines_for_boost_authors.adding_new_defect_macros"></a><a href="guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_defect_macros" title="Adding New Defect Macros">Adding
|
||||||
New Defect Macros</a>
|
New Defect Macros</a>
|
||||||
</h3></div></div></div>
|
</h3></div></div></div>
|
||||||
|
@@ -73,6 +73,8 @@
|
|||||||
<dt><span class="section"><a href="boost_config/guidelines_for_boost_authors.html">Guidelines for
|
<dt><span class="section"><a href="boost_config/guidelines_for_boost_authors.html">Guidelines for
|
||||||
Boost Authors</a></span></dt>
|
Boost Authors</a></span></dt>
|
||||||
<dd><dl>
|
<dd><dl>
|
||||||
|
<dt><span class="section"><a href="boost_config/guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.warnings">
|
||||||
|
Disabling Compiler Warings</a></span></dt>
|
||||||
<dt><span class="section"><a href="boost_config/guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_defect_macros">Adding
|
<dt><span class="section"><a href="boost_config/guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_defect_macros">Adding
|
||||||
New Defect Macros</a></span></dt>
|
New Defect Macros</a></span></dt>
|
||||||
<dt><span class="section"><a href="boost_config/guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_feature_test_macros">Adding
|
<dt><span class="section"><a href="boost_config/guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_feature_test_macros">Adding
|
||||||
@@ -958,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: April 04, 2008 at 08:46:37 GMT</small></p></td>
|
<td align="left"><p><small>Last revised: April 20, 2008 at 12:51:56 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>
|
||||||
|
Reference in New Issue
Block a user