mirrors/zig
1
0
Fork 0
mirror of https://codeberg.org/ziglang/zig.git synced 2025-12-06 13:54:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

std.log: don't state in docs that messages are logged to stderr

Browse source 
Since the logger implementation can be overridden, the messages might
not be logged to stderr at all.
This commit is contained in:
heidezomp 2020-08-12 15:54:21 +02:00
parent 25607079f0
commit bf2ed0f571
1 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
lib/std/log.zig
View file

@ -129,7 +129,7 @@ fn log(
}
}
/// Log an emergency message to stderr. This log level is intended to be used
/// Log an emergency message. This log level is intended to be used
/// for conditions that cannot be handled and is usually followed by a panic.
pub fn emerg(
comptime scope: @Type(.EnumLiteral),
@ -140,7 +140,7 @@ pub fn emerg(
log(.emerg, scope, format, args);
}
/// Log an alert message to stderr. This log level is intended to be used for
/// Log an alert message. This log level is intended to be used for
/// conditions that should be corrected immediately (e.g. database corruption).
pub fn alert(
comptime scope: @Type(.EnumLiteral),
@ -151,7 +151,7 @@ pub fn alert(
log(.alert, scope, format, args);
}
/// Log a critical message to stderr. This log level is intended to be used
/// Log a critical message. This log level is intended to be used
/// when a bug has been detected or something has gone wrong and it will have
/// an effect on the operation of the program.
pub fn crit(
@ -163,7 +163,7 @@ pub fn crit(
log(.crit, scope, format, args);
}
/// Log an error message to stderr. This log level is intended to be used when
/// Log an error message. This log level is intended to be used when
/// a bug has been detected or something has gone wrong but it is recoverable.
pub fn err(
comptime scope: @Type(.EnumLiteral),
@ -174,7 +174,7 @@ pub fn err(
log(.err, scope, format, args);
}
/// Log a warning message to stderr. This log level is intended to be used if
/// Log a warning message. This log level is intended to be used if
/// it is uncertain whether something has gone wrong or not, but the
/// circumstances would be worth investigating.
pub fn warn(
@ -185,7 +185,7 @@ pub fn warn(
log(.warn, scope, format, args);
}
/// Log a notice message to stderr. This log level is intended to be used for
/// Log a notice message. This log level is intended to be used for
/// non-error but significant conditions.
pub fn notice(
comptime scope: @Type(.EnumLiteral),
@ -195,7 +195,7 @@ pub fn notice(
log(.notice, scope, format, args);
}
/// Log an info message to stderr. This log level is intended to be used for
/// Log an info message. This log level is intended to be used for
/// general messages about the state of the program.
pub fn info(
comptime scope: @Type(.EnumLiteral),
@ -205,7 +205,7 @@ pub fn info(
log(.info, scope, format, args);
}
/// Log a debug message to stderr. This log level is intended to be used for
/// Log a debug message. This log level is intended to be used for
/// messages which are only useful for debugging.
pub fn debug(
comptime scope: @Type(.EnumLiteral),
@ -219,7 +219,7 @@ pub fn debug(
/// provided here.
pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
return struct {
/// Log an emergency message to stderr. This log level is intended to be used
/// Log an emergency message. This log level is intended to be used
/// for conditions that cannot be handled and is usually followed by a panic.
pub fn emerg(
comptime format: []const u8,
@ -229,7 +229,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
log(.emerg, scope, format, args);
}
/// Log an alert message to stderr. This log level is intended to be used for
/// Log an alert message. This log level is intended to be used for
/// conditions that should be corrected immediately (e.g. database corruption).
pub fn alert(
comptime format: []const u8,
@ -239,7 +239,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
log(.alert, scope, format, args);
}
/// Log a critical message to stderr. This log level is intended to be used
/// Log a critical message. This log level is intended to be used
/// when a bug has been detected or something has gone wrong and it will have
/// an effect on the operation of the program.
pub fn crit(
@ -250,7 +250,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
log(.crit, scope, format, args);
}
/// Log an error message to stderr. This log level is intended to be used when
/// Log an error message. This log level is intended to be used when
/// a bug has been detected or something has gone wrong but it is recoverable.
pub fn err(
comptime format: []const u8,
@ -260,7 +260,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
log(.err, scope, format, args);
}
/// Log a warning message to stderr. This log level is intended to be used if
/// Log a warning message. This log level is intended to be used if
/// it is uncertain whether something has gone wrong or not, but the
/// circumstances would be worth investigating.
pub fn warn(
@ -270,7 +270,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
log(.warn, scope, format, args);
}
/// Log a notice message to stderr. This log level is intended to be used for
/// Log a notice message. This log level is intended to be used for
/// non-error but significant conditions.
pub fn notice(
comptime format: []const u8,
@ -279,7 +279,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
log(.notice, scope, format, args);
}
/// Log an info message to stderr. This log level is intended to be used for
/// Log an info message. This log level is intended to be used for
/// general messages about the state of the program.
pub fn info(
comptime format: []const u8,
@ -288,7 +288,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
log(.info, scope, format, args);
}
/// Log a debug message to stderr. This log level is intended to be used for
/// Log a debug message. This log level is intended to be used for
/// messages which are only useful for debugging.
pub fn debug(
comptime format: []const u8,