diff --git a/doc/html/boost_config/acknowledgements.html b/doc/html/boost_config/acknowledgements.html index 8281d052..e3cd5555 100644 --- a/doc/html/boost_config/acknowledgements.html +++ b/doc/html/boost_config/acknowledgements.html @@ -3,7 +3,7 @@ Acknowledgements - + diff --git a/doc/html/boost_config/boost_macro_reference.html b/doc/html/boost_config/boost_macro_reference.html index bc8efb2d..caa4e5c9 100644 --- a/doc/html/boost_config/boost_macro_reference.html +++ b/doc/html/boost_config/boost_macro_reference.html @@ -3,7 +3,7 @@ Boost Macro Reference - + @@ -26,7 +26,7 @@

Boost Macro Reference

-
+
Macros that describe C++03 defects
Macros @@ -4556,8 +4556,39 @@ this macro expands to the equivalent of #pragma message(M). M must be a string - literal. Example: BOOST_PRAGMA_MESSAGE("This header - is deprecated."). + literal. +

+

+ Example: BOOST_PRAGMA_MESSAGE("This header + is deprecated.") +

+

+ The messages issued by BOOST_PRAGMA_MESSAGE + can be suppressed by defining the macro BOOST_DISABLE_PRAGMA_MESSAGE. +

+ + + + +

+ BOOST_HEADER_DEPRECATED(A) +

+ + +

+ Defined in header <boost/config/header_deprecated.hpp>, + this macro issues the message "This header is deprecated. + Use A instead." + via BOOST_PRAGMA_MESSAGE. + A must be a string + literal. +

+

+ Example: BOOST_HEADER_DEPRECATED("<boost/config/workaround.hpp>") +

+

+ The messages issued by BOOST_HEADER_DEPRECATED + can be suppressed by defining the macro BOOST_ALLOW_DEPRECATED_HEADERS.

@@ -5925,7 +5956,7 @@ Macros for libraries with separate source code
-
+
Macros controlling shared library symbol visibility
ABI diff --git a/doc/html/boost_config/build_config.html b/doc/html/boost_config/build_config.html index 2854a549..9be6b78f 100644 --- a/doc/html/boost_config/build_config.html +++ b/doc/html/boost_config/build_config.html @@ -3,7 +3,7 @@ Build Time Configuration - + diff --git a/doc/html/boost_config/cstdint.html b/doc/html/boost_config/cstdint.html index d75a289c..1baa5752 100644 --- a/doc/html/boost_config/cstdint.html +++ b/doc/html/boost_config/cstdint.html @@ -3,7 +3,7 @@ Standard Integer Types - + @@ -26,7 +26,7 @@
-
+
Overview
Rationale
Caveat emptor
diff --git a/doc/html/boost_config/guidelines_for_boost_authors.html b/doc/html/boost_config/guidelines_for_boost_authors.html index 212c9fbc..7773ce3b 100644 --- a/doc/html/boost_config/guidelines_for_boost_authors.html +++ b/doc/html/boost_config/guidelines_for_boost_authors.html @@ -3,7 +3,7 @@ Guidelines for Boost Authors - + @@ -27,7 +27,7 @@ Guidelines for Boost Authors
-
+
Disabling Compiler Warnings
Adding diff --git a/doc/html/boost_config/rationale.html b/doc/html/boost_config/rationale.html index 278516a5..8dc221fb 100644 --- a/doc/html/boost_config/rationale.html +++ b/doc/html/boost_config/rationale.html @@ -3,7 +3,7 @@ Rationale - + @@ -26,7 +26,7 @@
-
+
The problem
The solution
diff --git a/doc/html/index.html b/doc/html/index.html index 185c0357..8465dc90 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -3,7 +3,7 @@ Boost.Config - + @@ -39,7 +39,7 @@

Table of Contents

-
+
Configuring Boost for Your Platform
@@ -127,7 +127,7 @@ Configuring Boost for Your Platform
-
+
Using the default boost configuration
The @@ -725,7 +725,7 @@ Advanced configuration usage
-
+
Example 1: creating our own frozen configuration
Example @@ -992,7 +992,7 @@
- +

Last revised: December 12, 2017 at 18:14:39 GMT

Last revised: December 22, 2017 at 23:49:22 GMT
diff --git a/doc/macro_reference.qbk b/doc/macro_reference.qbk index e89f6555..9426531f 100644 --- a/doc/macro_reference.qbk +++ b/doc/macro_reference.qbk @@ -1282,7 +1282,21 @@ Usage example: ]] [[`BOOST_PRAGMA_MESSAGE(M)`][Defined in header ``, this macro expands to the equivalent of `#pragma message(M)`. `M` must be a string -literal. Example: `BOOST_PRAGMA_MESSAGE("This header is deprecated.")`.]] +literal. + +Example: `BOOST_PRAGMA_MESSAGE("This header is deprecated.")` + +The messages issued by `BOOST_PRAGMA_MESSAGE` can be suppressed by defining the macro +`BOOST_DISABLE_PRAGMA_MESSAGE`.]] + +[[`BOOST_HEADER_DEPRECATED(A)`][Defined in header ``, +this macro issues the message "This header is deprecated. Use `A` instead." via +`BOOST_PRAGMA_MESSAGE`. `A` must be a string literal. + +Example: `BOOST_HEADER_DEPRECATED("")` + +The messages issued by `BOOST_HEADER_DEPRECATED` can be suppressed by defining the macro +`BOOST_ALLOW_DEPRECATED_HEADERS`.]] ] [endsect] diff --git a/include/boost/config/header_deprecated.hpp b/include/boost/config/header_deprecated.hpp new file mode 100644 index 00000000..864554f2 --- /dev/null +++ b/include/boost/config/header_deprecated.hpp @@ -0,0 +1,26 @@ +#ifndef BOOST_CONFIG_HEADER_DEPRECATED_HPP_INCLUDED +#define BOOST_CONFIG_HEADER_DEPRECATED_HPP_INCLUDED + +// Copyright 2017 Peter Dimov. +// +// Distributed under 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 +// +// BOOST_HEADER_DEPRECATED("") +// +// Expands to the equivalent of +// BOOST_PRAGMA_MESSAGE("This header is deprecated. Use instead.") +// +// Note that this header is C compatible. + +#include + +#if defined(BOOST_ALLOW_DEPRECATED_HEADERS) +# define BOOST_HEADER_DEPRECATED(a) +#else +# define BOOST_HEADER_DEPRECATED(a) BOOST_PRAGMA_MESSAGE("This header is deprecated. Use " a " instead.") +#endif + +#endif // BOOST_CONFIG_HEADER_DEPRECATED_HPP_INCLUDED diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index 9f1e4ea4..ee6ecadb 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -105,6 +105,7 @@ test-suite config [ run config_build_check.cpp : : : [ requires int128 cxx11_constexpr cxx11_user_defined_literals ] ] [ run helper_macros_test.cpp ] [ compile pragma_message_test.cpp ] + [ compile header_deprecated_test.cpp ] ; obj has_clang_implicit_fallthrough : cmd_line_check.cpp : diff --git a/test/header_deprecated_test.cpp b/test/header_deprecated_test.cpp new file mode 100644 index 00000000..6a99a97d --- /dev/null +++ b/test/header_deprecated_test.cpp @@ -0,0 +1,18 @@ +// Copyright 2017 Peter Dimov. +// +// Distributed under 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 + +#include + +BOOST_HEADER_DEPRECATED("") + +#define ALTERNATIVE "the suitable component header" +BOOST_HEADER_DEPRECATED(ALTERNATIVE) + +#include // BOOST_STRINGIZE + +#define HEADER +BOOST_HEADER_DEPRECATED(BOOST_STRINGIZE(HEADER))