Commit 368ba53e authored by Steffen Müthing's avatar Steffen Müthing
Browse files

Remove any remaining traces of PDELab from the documentation and sources

parent d0b2aa42
Pipeline #19373 passed with stage
in 1 minute and 11 seconds
......@@ -12,7 +12,7 @@ License
-------
The dune-logging library, headers and test programs are copyrighted free software. You
can use, modify and/or redistribute it under the terms of either one of the two
can use, modify and/or redistribute it under the terms of either one of the three
following licenses:
* The GNU Lesser General Public License as published by the Free Software
......@@ -22,12 +22,12 @@ following licenses:
* Version 2 of the GNU General Public License as published by the Free Software
Foundation, with the following special exception for linking and compiling
against the PDELab library, the so-called "runtime exception":
against the dune-logging library, the so-called "runtime exception":
> As a special exception, you may use the PDELab source files as part of a
> As a special exception, you may use the dune-logging source files as part of a
> software library or application without restriction. Specifically, if other
> files instantiate templates or use macros or inline functions from one or
> more of the PDELab source files, or you compile one or more of the PDELab
> more of the dune-logging source files, or you compile one or more of the dune-logging
> source files and link them with other files to produce an executable, this
> does not by itself cause the resulting executable to be covered by the GNU
> General Public License. This exception does not however invalidate any
......@@ -42,12 +42,12 @@ following licenses:
External Libraries
------------------
PDELab contains the external [{fmt}][4] library in the subdirectory `vendor/fmt`,
dune-logging contains the external [{fmt}][4] library in the subdirectory `vendor/fmt`,
which is checked out as a Git submodule. This library is by default obtained from
a [mirror][5] of the original repository hosted on our GitLab. {fmt} is distributed
as part of PDELab if the build system cannot find an installed version of {fmt}.
as part of dune-logging if the build system cannot find an installed version of {fmt}.
{fmt} is licensed under the BSD 2-clause. For further information about the license and
{fmt} is licensed under the BSD 2-clause license. For further information about the license and
copyright information, see [vendor/fmt/README.rst][5] and [vendor/fmt/LICENSE.rst][6]
Links
......
......@@ -62,6 +62,6 @@ cannot find a preinstalled version of `fmtlib`.
License
-------
dune-logging is distributed under either the GNU LGPL 3 or LGPL 2 with a special exception, see
[COPYING.md] for detailed information. The vendored fmtlib is licensed under the BSD 2-clause license,
see [vendor/fmt/LICENSE.rst] for details.
dune-logging is distributed under either the GNU LGPL 3 or GNUGPL 2 with a special exception, see
[COPYING.md](COPYING.md) for detailed information. The vendored fmtlib is licensed under the BSD 2-clause
license, see [vendor/fmt/LICENSE.rst](vendor/fmt/LICENSE.rst) for details.
......@@ -8,14 +8,14 @@
/**
* \addtogroup checks Optional code correctness checks
* \brief Flags for enabling or disabling certain potentially expensive assertions in PDELab.
* \brief Flags for enabling or disabling certain potentially expensive assertions in dune-logging.
* \{
*/
/** \file
* Handling of PDELab-specific correctness verification flags.
* Handling of dune-logging-specific correctness verification flags.
*
* This file contains processing for a number of PDELab-specific verification flags that check the
* This file contains processing for a number of dune-logging-specific verification flags that check the
* correctness of your code with respect to different problems.
*
* All of these flags are enabled by default if your code is compiled in debug mode, i.e. when the
......
......@@ -28,7 +28,7 @@ namespace Dune::Logging {
//! A compile-time string that allows constructing constexpr string_views of the captured string.
/**
* This class is required for the compile-time validation of _fmt format strings and produced by
* the _fmt literal when DUNE_PDELAB_CHECK_FORMAT_STRINGS is enabled.
* the _fmt literal when DUNE_LOGGING_CHECK_FORMAT_STRINGS is enabled.
*/
template<typename Char, Char... chars>
struct format_string
......@@ -67,7 +67,7 @@ namespace Dune::Logging {
//! A special string_view that lets us ensure that users always use the _fmt literal for format strings.
/**
* This class is produced by the _fmt literal when DUNE_PDELAB_CHECK_FORMAT_STRINGS is disabled.
* This class is produced by the _fmt literal when DUNE_LOGGING_CHECK_FORMAT_STRINGS is disabled.
*/
struct format_string_view
: std::string_view
......
......@@ -64,7 +64,7 @@ namespace Dune::Logging {
*
* \warning Passing a normal string to the logging functions will result in a compile error!
*
* When you enable the macro `DUNE_PDELAB_CHECK_FORMAT_STRINGS`, the {fmt} library will check the
* When you enable the macro `DUNE_LOGGING_CHECK_FORMAT_STRINGS`, the {fmt} library will check the
* syntax of your format string at compile time and will make sure that you have provided all the
* arguments mentioned in the format string. This is enabled by default in debug builds.
*
......@@ -85,7 +85,7 @@ namespace Dune::Logging {
* Methods for submitting log messages
*
* Calling the logging methods is only allowed if `attached() == true`, otherwise you either get
* an exception or undefined behavior, depending on DUNE_PDELAB_CHECK_LOGGER.
* an exception or undefined behavior, depending on DUNE_LOGGING_CHECK_LOGGER.
*
* \{
*/
......@@ -226,6 +226,13 @@ namespace Dune::Logging {
(*this)(LogLevel::warning,std::forward<Args>(args)...);
}
//! Logs the given message at LogLevel::warning.
template<typename... Args>
void warn(Args&&... args)
{
(*this)(LogLevel::warning,std::forward<Args>(args)...);
}
//! Logs the given message at LogLevel::notice.
template<typename... Args>
void notice(Args&&... args)
......
......@@ -179,7 +179,7 @@ namespace Dune::Logging {
, clog_buf(true)
{
if (not comm_)
DUNE_THROW(LoggingError,"You must call Dune::PDELab::Logging::init() before using the logging system");
DUNE_THROW(LoggingError,"You must call Dune::Logging::init() before using the logging system");
comm.emplace(*comm_);
}
......
......@@ -116,4 +116,4 @@ namespace fmt {
#endif // DOXYGEN
#endif // DUNE_PDELAB_LOGGING_LOGLEVEL_HH
#endif // DUNE_LOGGING_LOGLEVEL_HH
......@@ -164,4 +164,4 @@ namespace Dune::Logging {
} // end namespace Dune::Logging
#endif // DUNE_PDELAB_LOGGING_LOGMESSAGE_HH
#endif // DUNE_LOGGING_LOGMESSAGE_HH
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment