This is an automated email from the ASF dual-hosted git repository.
swebb2066 pushed a commit to branch next_stable
in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git
The following commit(s) were added to refs/heads/next_stable by this push:
new 6f15b527 Update default initialization documentation to reflect
changes in (#150)
6f15b527 is described below
commit 6f15b527b6b009d215ede9d6ebd18405449663d8
Author: Stephen Webb <[email protected]>
AuthorDate: Mon Dec 12 15:02:16 2022 +1100
Update default initialization documentation to reflect changes in (#150)
---
src/main/include/log4cxx/logmanager.h | 50 ++++++++++++++++++++---------------
src/site/markdown/usage.md | 10 +++----
2 files changed, 32 insertions(+), 28 deletions(-)
diff --git a/src/main/include/log4cxx/logmanager.h
b/src/main/include/log4cxx/logmanager.h
index d2aa2854..465f7187 100644
--- a/src/main/include/log4cxx/logmanager.h
+++ b/src/main/include/log4cxx/logmanager.h
@@ -72,8 +72,8 @@ class LOG4CXX_EXPORT LogManager
/**
Retrieve the root logger from the {@link spi::LoggerRepository
LoggerRepository}.
- Call {@link spi::LoggerRepository::autoConfigure autoConfigure}
- if the repository is not yet configured.
+ Calls {@link spi::LoggerRepository::ensureIsConfigured
ensureIsConfigured} passing {@link DefaultConfigurator::configure} to ensure
+ the repository is configured.
*/
static LoggerPtr getRootLogger();
@@ -82,8 +82,8 @@ class LOG4CXX_EXPORT LogManager
{@link spi::LoggerRepository LoggerRepository}
using DefaultLoggerFactory to create it if required.
- Call {@link spi::LoggerRepository::autoConfigure autoConfigure}
- if the repository is not yet configured.
+ Calls {@link spi::LoggerRepository::ensureIsConfigured
ensureIsConfigured} passing {@link DefaultConfigurator::configure} to ensure
+ the repository is configured.
*/
static LoggerPtr getLogger(const std::string& name);
@@ -92,8 +92,8 @@ class LOG4CXX_EXPORT LogManager
{@link spi::LoggerRepository LoggerRepository}
using \c factory to create it if required.
- Call {@link spi::LoggerRepository::autoConfigure autoConfigure}
- if the repository is not yet configured.
+ Calls {@link spi::LoggerRepository::ensureIsConfigured
ensureIsConfigured} passing {@link DefaultConfigurator::configure} to ensure
+ the repository is configured.
*/
static LoggerPtr getLogger(const std::string& name,
const spi::LoggerFactoryPtr& factory);
@@ -107,8 +107,8 @@ class LOG4CXX_EXPORT LogManager
{@link spi::LoggerRepository LoggerRepository}
using DefaultLoggerFactory to create it if required.
- Call {@link spi::LoggerRepository::autoConfigure autoConfigure}
- if the repository is not yet configured.
+ Calls {@link spi::LoggerRepository::ensureIsConfigured
ensureIsConfigured} passing {@link DefaultConfigurator::configure} to ensure
+ the repository is configured.
*/
static LoggerPtr getLogger(const std::wstring& name);
/**
@@ -116,8 +116,8 @@ class LOG4CXX_EXPORT LogManager
{@link spi::LoggerRepository LoggerRepository}
using \c factory to create it if required.
- Call {@link spi::LoggerRepository::autoConfigure autoConfigure}
- if the repository is not yet configured.
+ Calls {@link spi::LoggerRepository::ensureIsConfigured
ensureIsConfigured} passing {@link DefaultConfigurator::configure} to ensure
+ the repository is configured.
*/
static LoggerPtr getLogger(const std::wstring& name,
const spi::LoggerFactoryPtr& factory);
@@ -132,8 +132,9 @@ class LOG4CXX_EXPORT LogManager
{@link spi::LoggerRepository LoggerRepository}
using DefaultLoggerFactory to create it if required.
- Call {@link spi::LoggerRepository::autoConfigure autoConfigure}
- if the repository is not yet configured.
+ Calls {@link spi::LoggerRepository::ensureIsConfigured
ensureIsConfigured}
+ passing {@link DefaultConfigurator::configure} to ensure
+ the repository is configured.
*/
static LoggerPtr getLogger(const std::basic_string<UniChar>&
name);
/**
@@ -141,8 +142,9 @@ class LOG4CXX_EXPORT LogManager
{@link spi::LoggerRepository LoggerRepository}
using \c factory to create it if required.
- Call {@link spi::LoggerRepository::autoConfigure autoConfigure}
- if the repository is not yet configured.
+ Calls {@link spi::LoggerRepository::ensureIsConfigured
ensureIsConfigured}
+ passing {@link DefaultConfigurator::configure} to ensure
+ the repository is configured.
*/
static LoggerPtr getLogger(const std::basic_string<UniChar>&
name,
const spi::LoggerFactoryPtr& factory);
@@ -157,8 +159,9 @@ class LOG4CXX_EXPORT LogManager
{@link spi::LoggerRepository LoggerRepository}
using DefaultLoggerFactory to create it if required.
- Call {@link spi::LoggerRepository::autoConfigure autoConfigure}
- if the repository is not yet configured.
+ Calls {@link spi::LoggerRepository::ensureIsConfigured
ensureIsConfigured}
+ passing {@link DefaultConfigurator::configure} to ensure
+ the repository is configured.
*/
static LoggerPtr getLogger(const CFStringRef& name);
/**
@@ -166,8 +169,9 @@ class LOG4CXX_EXPORT LogManager
{@link spi::LoggerRepository LoggerRepository}
using \c factory to create it if required.
- Call {@link spi::LoggerRepository::autoConfigure autoConfigure}
- if the repository is not yet configured.
+ Calls {@link spi::LoggerRepository::ensureIsConfigured
ensureIsConfigured}
+ passing {@link DefaultConfigurator::configure} to ensure
+ the repository is configured.
*/
static LoggerPtr getLogger(const CFStringRef& name,
const spi::LoggerFactoryPtr& factory);
@@ -183,8 +187,9 @@ class LOG4CXX_EXPORT LogManager
{@link spi::LoggerRepository LoggerRepository}
using DefaultLoggerFactory to create it if required.
- Call {@link spi::LoggerRepository::autoConfigure autoConfigure}
- if the repository is not yet configured.
+ Calls {@link spi::LoggerRepository::ensureIsConfigured
ensureIsConfigured}
+ passing {@link DefaultConfigurator::configure} to ensure
+ the repository is configured.
*/
static LoggerPtr getLoggerLS(const LogString& name);
/**
@@ -192,8 +197,9 @@ class LOG4CXX_EXPORT LogManager
{@link spi::LoggerRepository LoggerRepository}
using \c factory to create it if required.
- Call {@link spi::LoggerRepository::autoConfigure autoConfigure}
- if the repository is not yet configured.
+ Calls {@link spi::LoggerRepository::ensureIsConfigured
ensureIsConfigured}
+ passing {@link DefaultConfigurator::configure} to ensure
+ the repository is configured.
*/
static LoggerPtr getLoggerLS(const LogString& name,
const spi::LoggerFactoryPtr& factory);
diff --git a/src/site/markdown/usage.md b/src/site/markdown/usage.md
index a79b65d6..42c8da71 100644
--- a/src/site/markdown/usage.md
+++ b/src/site/markdown/usage.md
@@ -604,12 +604,10 @@ However the library will attempt automatic configuration.
If the LoggerRepositoy is not yet configured on the first call to
[getLogger](@ref log4cxx.LogManager.getLogger) of [LogManager](@ref
log4cxx.LogManager),
-the [autoConfigure](@ref log4cxx.spi.LoggerRepository.autoConfigure) virtual
method
-of [LoggerRepository](@ref log4cxx.spi.LoggerRepository) is called.
-
-The [default autoConfigure](@ref log4cxx.Hierarchy.autoConfigure)
implementation
-calls the [configure](@ref log4cxx.DefaultConfigurator.configure) method
-of the [DefaultConfigurator](@ref log4cxx.DefaultConfigurator) class.
+the [configure](@ref log4cxx.DefaultConfigurator.configure) method
+of [DefaultConfigurator](@ref log4cxx.DefaultConfigurator) is called
+via [ensureIsConfigured](@ref log4cxx.spi.LoggerRepository.ensureIsConfigured)
method
+of [LoggerRepository](@ref log4cxx.spi.LoggerRepository).
To use automatic configuration with a non-standard file name
create and use your own wrapper for [getLogger](@ref
log4cxx.LogManager.getLogger).
