mirrors/phobos
1
0
Fork 0
mirror of https://github.com/dlang/phobos.git synced 2025-05-06 11:07:39 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #4678 from llucenic/patch-1

Browse source 
Typos corrections for logger
This commit is contained in:
David Nadlinger 2016-07-31 13:47:52 +01:00 • committed by GitHub
commit 50ad274826
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
std/experimental/logger/package.d
View file

@ -20,7 +20,7 @@ void main() {
} }
------------- -------------
This will print a message to the $(D stderr) device. The message will contain This will print a message to the $(D stderr) device. The message will contain
the filename, the linenumber, the name of the surrounding function, the time the filename, the line number, the name of the surrounding function, the time
and the message. and the message.
More complex log call can go along the lines like: More complex log call can go along the lines like:
@ -58,7 +58,7 @@ $(UL
) )
The default $(D Logger) will by default log to $(D stderr) and has a default The default $(D Logger) will by default log to $(D stderr) and has a default
$(D LogLevel) of $(D LogLevel.all). The default Logger can be accessed by $(D LogLevel) of $(D LogLevel.all). The default Logger can be accessed by
using the property called $(D sharedLog). This property a reference to the using the property called $(D sharedLog). This property is a reference to the
current default $(D Logger). This reference can be used to assign a new current default $(D Logger). This reference can be used to assign a new
default $(D Logger). default $(D Logger).
------------- -------------
@ -71,10 +71,10 @@ required $(D Logger).
$(H3 Logging Fundamentals) $(H3 Logging Fundamentals)
$(H4 LogLevel) $(H4 LogLevel)
The $(D LogLevel) of a log call can be defined in two ways. The first is by The $(D LogLevel) of a log call can be defined in two ways. The first is by
calling $(D log) and passing the $(D LogLevel) explicit as the first argument. calling $(D log) and passing the $(D LogLevel) explicitly as the first argument.
The second way of setting the $(D LogLevel) of a The second way of setting the $(D LogLevel) of a
log call, is by calling either $(D trace), $(D info), $(D warning), log call, is by calling either $(D trace), $(D info), $(D warning),
$(D critical), or $(D fatal). The log call will than have the respective $(D critical), or $(D fatal). The log call will then have the respective
$(D LogLevel). If no $(D LogLevel) is defined the log call will use the $(D LogLevel). If no $(D LogLevel) is defined the log call will use the
current $(D LogLevel) of the used $(D Logger). If data is logged with current $(D LogLevel) of the used $(D Logger). If data is logged with
$(D LogLevel) $(D fatal) by default an $(D Error) will be thrown. $(D LogLevel) $(D fatal) by default an $(D Error) will be thrown.
@ -92,12 +92,12 @@ $(D bool).
$(H4 Filtering Log Messages) $(H4 Filtering Log Messages)
Messages are logged if the $(D LogLevel) of the log message is greater than or Messages are logged if the $(D LogLevel) of the log message is greater than or
equal to than the $(D LogLevel) of the used $(D Logger) and additionally if the equal to the $(D LogLevel) of the used $(D Logger) and additionally if the
$(D LogLevel) of the log message is greater equal to the global $(D LogLevel). $(D LogLevel) of the log message is greater than or equal to the global $(D LogLevel).
If a condition is passed into the log call, this condition must be true. If a condition is passed into the log call, this condition must be true.
The global $(D LogLevel) is accessible by using $(D globalLogLevel). The global $(D LogLevel) is accessible by using $(D globalLogLevel).
To assign the $(D LogLevel) of a $(D Logger) use the $(D logLevel) property of To assign a $(D LogLevel) of a $(D Logger) use the $(D logLevel) property of
the logger. the logger.
$(H4 Printf Style Logging) $(H4 Printf Style Logging)
@ -110,12 +110,12 @@ logging functions and methods.
$(H4 Thread Local Redirection) $(H4 Thread Local Redirection)
Calls to the free standing log functions are not directly forwarded to the Calls to the free standing log functions are not directly forwarded to the
global $(D Logger) $(D sharedLog). Actually, a thread local $(D Logger) of global $(D Logger) $(D sharedLog). Actually, a thread local $(D Logger) of
type $(D StdForwardLogger) process the log call and then, by default, forward type $(D StdForwardLogger) processes the log call and then, by default, forwards
the created $(D Logger.LogEntry) to the $(D sharedLog) $(D Logger). the created $(D Logger.LogEntry) to the $(D sharedLog) $(D Logger).
The thread local $(D Logger) is accessable by the $(D stdThreadLocalLog) The thread local $(D Logger) is accessible by the $(D stdThreadLocalLog)
property. This property allows to assign user defined $(D Logger). The default property. This property allows to assign user defined $(D Logger). The default
$(D LogLevel) of the $(D stdThreadLocalLog) $(D Logger) is $(D LogLevel.all) $(D LogLevel) of the $(D stdThreadLocalLog) $(D Logger) is $(D LogLevel.all)
and it will therefore forward all messaged to the $(D sharedLog) $(D Logger). and it will therefore forward all messages to the $(D sharedLog) $(D Logger).
The $(D LogLevel) of the $(D stdThreadLocalLog) can be used to filter log The $(D LogLevel) of the $(D stdThreadLocalLog) can be used to filter log
calls before they reach the $(D sharedLog) $(D Logger). calls before they reach the $(D sharedLog) $(D Logger).
@ -142,8 +142,8 @@ logger.log("Awesome log message with LogLevel.info");
------------- -------------
To gain more precise control over the logging process, additionally to To gain more precise control over the logging process, additionally to
overwriting the $(D writeLogMsg) method the methods $(D beginLogMsg), overriding the $(D writeLogMsg) method the methods $(D beginLogMsg),
$(D logMsgPart) and $(D finishLogMsg) can be overwritten. $(D logMsgPart) and $(D finishLogMsg) can be overridden.
$(H3 Compile Time Disabling of $(D Logger)) $(H3 Compile Time Disabling of $(D Logger))
In order to disable logging at compile time, pass $(D StdLoggerDisableLogging) as a In order to disable logging at compile time, pass $(D StdLoggerDisableLogging) as a