authorgravatar for heidezomp@protonmail.comheidezomp <heidezomp@protonmail.com> 2020-08-12 15:54:21+02:00
committergravatar for heidezomp@protonmail.comheidezomp <heidezomp@protonmail.com> 2020-08-12 15:54:21+02:00
logbf2ed0f571736241151a358b2533d45cb769db68
treeed21b8fb7fafaecf3cbd7db4ca91cda20dc0cb5d
parent25607079f0f405d09202378d7435a59a7a96d649

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

Since the logger implementation can be overridden, the messages might not be logged to stderr at all.

1 files changed, 16 insertions(+), 16 deletions(-)

lib/std/log.zig+16-16
......@@ -129,7 +129,7 @@ fn log(
129129 }
130130}
131131
132/// Log an emergency message to stderr. This log level is intended to be used
132/// Log an emergency message. This log level is intended to be used
133133/// for conditions that cannot be handled and is usually followed by a panic.
134134pub fn emerg(
135135 comptime scope: @Type(.EnumLiteral),
......@@ -140,7 +140,7 @@ pub fn emerg(
140140 log(.emerg, scope, format, args);
141141}
142142
143/// Log an alert message to stderr. This log level is intended to be used for
143/// Log an alert message. This log level is intended to be used for
144144/// conditions that should be corrected immediately (e.g. database corruption).
145145pub fn alert(
146146 comptime scope: @Type(.EnumLiteral),
......@@ -151,7 +151,7 @@ pub fn alert(
151151 log(.alert, scope, format, args);
152152}
153153
154/// Log a critical message to stderr. This log level is intended to be used
154/// Log a critical message. This log level is intended to be used
155155/// when a bug has been detected or something has gone wrong and it will have
156156/// an effect on the operation of the program.
157157pub fn crit(
......@@ -163,7 +163,7 @@ pub fn crit(
163163 log(.crit, scope, format, args);
164164}
165165
166/// Log an error message to stderr. This log level is intended to be used when
166/// Log an error message. This log level is intended to be used when
167167/// a bug has been detected or something has gone wrong but it is recoverable.
168168pub fn err(
169169 comptime scope: @Type(.EnumLiteral),
......@@ -174,7 +174,7 @@ pub fn err(
174174 log(.err, scope, format, args);
175175}
176176
177/// Log a warning message to stderr. This log level is intended to be used if
177/// Log a warning message. This log level is intended to be used if
178178/// it is uncertain whether something has gone wrong or not, but the
179179/// circumstances would be worth investigating.
180180pub fn warn(
......@@ -185,7 +185,7 @@ pub fn warn(
185185 log(.warn, scope, format, args);
186186}
187187
188/// Log a notice message to stderr. This log level is intended to be used for
188/// Log a notice message. This log level is intended to be used for
189189/// non-error but significant conditions.
190190pub fn notice(
191191 comptime scope: @Type(.EnumLiteral),
......@@ -195,7 +195,7 @@ pub fn notice(
195195 log(.notice, scope, format, args);
196196}
197197
198/// Log an info message to stderr. This log level is intended to be used for
198/// Log an info message. This log level is intended to be used for
199199/// general messages about the state of the program.
200200pub fn info(
201201 comptime scope: @Type(.EnumLiteral),
......@@ -205,7 +205,7 @@ pub fn info(
205205 log(.info, scope, format, args);
206206}
207207
208/// Log a debug message to stderr. This log level is intended to be used for
208/// Log a debug message. This log level is intended to be used for
209209/// messages which are only useful for debugging.
210210pub fn debug(
211211 comptime scope: @Type(.EnumLiteral),
......@@ -219,7 +219,7 @@ pub fn debug(
219219/// provided here.
220220pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
221221 return struct {
222 /// Log an emergency message to stderr. This log level is intended to be used
222 /// Log an emergency message. This log level is intended to be used
223223 /// for conditions that cannot be handled and is usually followed by a panic.
224224 pub fn emerg(
225225 comptime format: []const u8,
......@@ -229,7 +229,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
229229 log(.emerg, scope, format, args);
230230 }
231231
232 /// Log an alert message to stderr. This log level is intended to be used for
232 /// Log an alert message. This log level is intended to be used for
233233 /// conditions that should be corrected immediately (e.g. database corruption).
234234 pub fn alert(
235235 comptime format: []const u8,
......@@ -239,7 +239,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
239239 log(.alert, scope, format, args);
240240 }
241241
242 /// Log a critical message to stderr. This log level is intended to be used
242 /// Log a critical message. This log level is intended to be used
243243 /// when a bug has been detected or something has gone wrong and it will have
244244 /// an effect on the operation of the program.
245245 pub fn crit(
......@@ -250,7 +250,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
250250 log(.crit, scope, format, args);
251251 }
252252
253 /// Log an error message to stderr. This log level is intended to be used when
253 /// Log an error message. This log level is intended to be used when
254254 /// a bug has been detected or something has gone wrong but it is recoverable.
255255 pub fn err(
256256 comptime format: []const u8,
......@@ -260,7 +260,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
260260 log(.err, scope, format, args);
261261 }
262262
263 /// Log a warning message to stderr. This log level is intended to be used if
263 /// Log a warning message. This log level is intended to be used if
264264 /// it is uncertain whether something has gone wrong or not, but the
265265 /// circumstances would be worth investigating.
266266 pub fn warn(
......@@ -270,7 +270,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
270270 log(.warn, scope, format, args);
271271 }
272272
273 /// Log a notice message to stderr. This log level is intended to be used for
273 /// Log a notice message. This log level is intended to be used for
274274 /// non-error but significant conditions.
275275 pub fn notice(
276276 comptime format: []const u8,
......@@ -279,7 +279,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
279279 log(.notice, scope, format, args);
280280 }
281281
282 /// Log an info message to stderr. This log level is intended to be used for
282 /// Log an info message. This log level is intended to be used for
283283 /// general messages about the state of the program.
284284 pub fn info(
285285 comptime format: []const u8,
......@@ -288,7 +288,7 @@ pub fn scoped(comptime scope: @Type(.EnumLiteral)) type {
288288 log(.info, scope, format, args);
289289 }
290290
291 /// Log a debug message to stderr. This log level is intended to be used for
291 /// Log a debug message. This log level is intended to be used for
292292 /// messages which are only useful for debugging.
293293 pub fn debug(
294294 comptime format: []const u8,