luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'alatiera/gmessage-docs' into 'main'

Browse Source 
docs: Fix member names of GLib.LogLevelFlags

See merge request GNOME/glib!3841
This commit is contained in:
Michael Catanzaro 2024-01-19 17:33:56 +00:00
commit 75310f658d
1 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
glib/gmessages.c
View File

@ -210,9 +210,9 @@
* trusted files, etc.) * trusted files, etc.)
* *
* If attempting to deal with programmer errors (for example, incorrect function * If attempting to deal with programmer errors (for example, incorrect function
* parameters) then you should use [flags@GLib.LogLevelFlags.CRITICAL] instead. * parameters) then you should use [flags@GLib.LogLevelFlags.LEVEL_CRITICAL] instead.
* *
* [func@GLib.warn_if_reached] and func@GLib.warn_if_fail] log at [flags@GLib.LogLevelFlags.WARNING]. * [func@GLib.warn_if_reached] and func@GLib.warn_if_fail] log at [flags@GLib.LogLevelFlags.LEVEL_WARNING].
* *
* You can make warnings fatal at runtime by setting the `G_DEBUG` * You can make warnings fatal at runtime by setting the `G_DEBUG`
* environment variable (see * environment variable (see
@ -239,7 +239,7 @@
* @...: format string, followed by parameters to insert into the format string * @...: format string, followed by parameters to insert into the format string
* (as with `printf()`) * (as with `printf()`)
* *
* Logs a ‘critical warning’ ([flags@GLib.LogLevelFlags.CRITICAL]). * Logs a ‘critical warning’ ([flags@GLib.LogLevelFlags.LEVEL_CRITICAL]).
* *
* Critical warnings are intended to be used in the event of an error * Critical warnings are intended to be used in the event of an error
* that originated in the current process (a programmer error). * that originated in the current process (a programmer error).
@ -247,7 +247,7 @@
* somewhere in the current program (or its libraries). * somewhere in the current program (or its libraries).
* *
* [func@GLib.return_if_fail], [func@GLib.return_val_if_fail], [func@GLib.return_if_reached] and * [func@GLib.return_if_fail], [func@GLib.return_val_if_fail], [func@GLib.return_if_reached] and
* [func@GLib.return_val_if_reached] log at [flags@GLib.LogLevelFlags.CRITICAL]. * [func@GLib.return_val_if_reached] log at [flags@GLib.LogLevelFlags.LEVEL_CRITICAL].
* *
* You can make critical warnings fatal at runtime by * You can make critical warnings fatal at runtime by
* setting the `G_DEBUG` environment variable (see * setting the `G_DEBUG` environment variable (see
@ -561,7 +561,7 @@ g_log_domain_get_handler_L (GLogDomain *domain,
* *
* When a message with any of these levels is logged the program terminates. * When a message with any of these levels is logged the program terminates.
* You can only set the levels defined by GLib to be fatal. * You can only set the levels defined by GLib to be fatal.
* [flags@GLib.LogLevelFlags.ERROR] is always fatal. * [flags@GLib.LogLevelFlags.LEVEL_ERROR] is always fatal.
* *
* You can also make some message levels fatal at runtime by setting * You can also make some message levels fatal at runtime by setting
* the `G_DEBUG` environment variable (see * the `G_DEBUG` environment variable (see
@ -606,7 +606,7 @@ g_log_set_always_fatal (GLogLevelFlags fatal_mask)
* *
* Sets the log levels which are fatal in the given domain. * Sets the log levels which are fatal in the given domain.
* *
* [flags@GLib.LogLevelFlags.ERROR] is always fatal. * [flags@GLib.LogLevelFlags.LEVEL_ERROR] is always fatal.
* *
* This has no effect on structured log messages (using [func@GLib.log_structured] or * This has no effect on structured log messages (using [func@GLib.log_structured] or
* [func@GLib.log_structured_array]). To change the fatal behaviour for specific log * [func@GLib.log_structured_array]). To change the fatal behaviour for specific log
@ -615,9 +615,9 @@ g_log_set_always_fatal (GLogLevelFlags fatal_mask)
* [Using Structured Logging](logging.html#using-structured-logging). * [Using Structured Logging](logging.html#using-structured-logging).
* *
* This function is mostly intended to be used with * This function is mostly intended to be used with
* [flags@GLib.LogLevelFlags.CRITICAL]. You should typically not set * [flags@GLib.LogLevelFlags.LEVEL_CRITICAL]. You should typically not set
* [flags@GLib.LogLevelFlags.WARNING], [flags@GLib.LogLevelFlags.MESSAGE], [flags@GLib.LogLevelFlags.INFO] or * [flags@GLib.LogLevelFlags.LEVEL_WARNING], [flags@GLib.LogLevelFlags.LEVEL_MESSAGE], [flags@GLib.LogLevelFlags.LEVEL_INFO] or
* [flags@GLib.LogLevelFlags.DEBUG] as fatal except inside of test programs. * [flags@GLib.LogLevelFlags.LEVEL_DEBUG] as fatal except inside of test programs.
* *
* Returns: the old fatal mask for the log domain * Returns: the old fatal mask for the log domain
*/ */
@ -657,20 +657,20 @@ g_log_set_fatal_mask (const gchar *log_domain,
* application domain * application domain
* @log_levels: the log levels to apply the log handler for. * @log_levels: the log levels to apply the log handler for.
* To handle fatal and recursive messages as well, combine * To handle fatal and recursive messages as well, combine
* the log levels with the [flags@GLib.LogLevelFlags.FATAL] and * the log levels with the [flags@GLib.LogLevelFlags.FLAG_FATAL] and
* [flags@GLib.LogLevelFlags.RECURSION] bit flags. * [flags@GLib.LogLevelFlags.FLAG_RECURSION] bit flags.
* @log_func: the log handler function * @log_func: the log handler function
* @user_data: data passed to the log handler * @user_data: data passed to the log handler
* *
* Sets the log handler for a domain and a set of log levels. * Sets the log handler for a domain and a set of log levels.
* *
* To handle fatal and recursive messages the @log_levels parameter * To handle fatal and recursive messages the @log_levels parameter
* must be combined with the [flags@GLib.LogLevelFlags.FATAL] and [flags@GLib.LogLevelFlags.RECURSION] * must be combined with the [flags@GLib.LogLevelFlags.FLAG_FATAL] and [flags@GLib.LogLevelFlags.FLAG_RECURSION]
* bit flags. * bit flags.
* *
* Note that since the [flags@GLib.LogLevelFlags.ERROR] log level is always fatal, if * Note that since the [flags@GLib.LogLevelFlags.LEVEL_ERROR] log level is always fatal, if
* you want to set a handler for this log level you must combine it with * you want to set a handler for this log level you must combine it with
* [flags@GLib.LogLevelFlags.FATAL]. * [flags@GLib.LogLevelFlags.FLAG_FATAL].
* *
* This has no effect if structured logging is enabled; see * This has no effect if structured logging is enabled; see
* [Using Structured Logging](logging.html#using-structured-logging). * [Using Structured Logging](logging.html#using-structured-logging).
@ -714,8 +714,8 @@ g_log_set_handler (const gchar *log_domain,
* application domain * application domain
* @log_levels: the log levels to apply the log handler for. * @log_levels: the log levels to apply the log handler for.
* To handle fatal and recursive messages as well, combine * To handle fatal and recursive messages as well, combine
* the log levels with the [flags@GLib.LogLevelFlags.FATAL] and * the log levels with the [flags@GLib.LogLevelFlags.FLAG_FATAL] and
* [flags@GLib.LogLevelFlags.RECURSION] bit flags. * [flags@GLib.LogLevelFlags.FLAG_RECURSION] bit flags.
* @log_func: the log handler function * @log_func: the log handler function
* @user_data: data passed to the log handler * @user_data: data passed to the log handler
* @destroy: destroy notify for @user_data, or `NULL` * @destroy: destroy notify for @user_data, or `NULL`
@ -1041,8 +1041,8 @@ static gboolean gmessages_use_stderr = FALSE;
* old-style API, and both [func@GLib.log_writer_default] and * old-style API, and both [func@GLib.log_writer_default] and
* [func@GLib.log_writer_standard_streams] for the structured API. * [func@GLib.log_writer_standard_streams] for the structured API.
* *
* By default, log messages of levels [flags@GLib.LogLevelFlags.INFO] and * By default, log messages of levels [flags@GLib.LogLevelFlags.LEVEL_INFO] and
* [flags@GLib.LogLevelFlags.DEBUG] are sent to `stdout`, and other log messages are * [flags@GLib.LogLevelFlags.LEVEL_DEBUG] are sent to `stdout`, and other log messages are
* sent to `stderr`. This is problematic for applications that intend * sent to `stderr`. This is problematic for applications that intend
* to reserve `stdout` for structured output such as JSON or XML. * to reserve `stdout` for structured output such as JSON or XML.
* *
@ -1498,7 +1498,7 @@ done_query:
* *
* The message will be passed through to the log writer set by the application * The message will be passed through to the log writer set by the application
* using [func@GLib.log_set_writer_func]. If the message is fatal (i.e. its log level * using [func@GLib.log_set_writer_func]. If the message is fatal (i.e. its log level
* is [flags@GLib.LogLevelFlags.ERROR]), the program will be aborted by calling * is [flags@GLib.LogLevelFlags.LEVEL_ERROR]), the program will be aborted by calling
* [func@GLib.BREAKPOINT] at the end of this function. If the log writer returns * [func@GLib.BREAKPOINT] at the end of this function. If the log writer returns
* [enum@GLib.LogWriterOutput.UNHANDLED] (failure), no other fallback writers will be tried. * [enum@GLib.LogWriterOutput.UNHANDLED] (failure), no other fallback writers will be tried.
* See the documentation for [type@GLib.LogWriterFunc] for information on chaining * See the documentation for [type@GLib.LogWriterFunc] for information on chaining
@ -1818,7 +1818,7 @@ static GLogWriterOutput _g_log_writer_fallback (GLogLevelFlags log_level,
* *
* The message will be passed through to the log writer set by the application * The message will be passed through to the log writer set by the application
* using [func@GLib.log_set_writer_func]. If the * using [func@GLib.log_set_writer_func]. If the
* message is fatal (i.e. its log level is [flags@GLib.LogLevelFlags.ERROR]), the program will * message is fatal (i.e. its log level is [flags@GLib.LogLevelFlags.LEVEL_ERROR]), the program will
* be aborted at the end of this function. * be aborted at the end of this function.
* *
* See [func@GLib.log_structured] for more documentation. * See [func@GLib.log_structured] for more documentation.
@ -2565,7 +2565,7 @@ g_log_writer_journald (GLogLevelFlags log_level,
* Format a structured log message and print it to either `stdout` or `stderr`, * Format a structured log message and print it to either `stdout` or `stderr`,
* depending on its log level. * depending on its log level.
* *
* [flags@GLib.LogLevelFlags.INFO] and [flags@GLib.LogLevelFlags.DEBUG] messages * [flags@GLib.LogLevelFlags.LEVEL_INFO] and [flags@GLib.LogLevelFlags.LEVEL_DEBUG] messages
* are sent to `stdout`, or to `stderr` if requested by * are sent to `stdout`, or to `stderr` if requested by
* [func@GLib.log_writer_default_set_use_stderr]; * [func@GLib.log_writer_default_set_use_stderr];
* all other log levels are sent to `stderr`. Only fields * all other log levels are sent to `stderr`. Only fields
@ -3101,7 +3101,7 @@ g_assert_warning (const char *log_domain,
* [func@GLib.error] intentionally never returns even if the program doesn’t * [func@GLib.error] intentionally never returns even if the program doesn’t
* abort; use [func@GLib.test_trap_subprocess] in this case. * abort; use [func@GLib.test_trap_subprocess] in this case.
* *
* If messages at [flags@GLib.LogLevelFlags.DEBUG] are emitted, but not explicitly * If messages at [flags@GLib.LogLevelFlags.LEVEL_DEBUG] are emitted, but not explicitly
* expected via [func@GLib.test_expect_message] then they will be ignored. * expected via [func@GLib.test_expect_message] then they will be ignored.
* *
* Since: 2.34 * Since: 2.34
@ -3158,7 +3158,7 @@ g_test_assert_expected_messages_internal (const char *domain,
* `G_LOG_USE_STRUCTURED` defined). It will not work with the structured logging * `G_LOG_USE_STRUCTURED` defined). It will not work with the structured logging
* API. See [Testing for Messages](logging.html#testing-for-messages). * API. See [Testing for Messages](logging.html#testing-for-messages).
* *
* If messages at [flags@GLib.LogLevelFlags.DEBUG] are emitted, but not explicitly * If messages at [flags@GLib.LogLevelFlags.LEVEL_DEBUG] are emitted, but not explicitly
* expected via [func@GLib.test_expect_message] then they will be ignored. * expected via [func@GLib.test_expect_message] then they will be ignored.
* *
* Since: 2.34 * Since: 2.34
@ -3301,9 +3301,9 @@ escape_string (GString *string)
* these messages are not printed. If you need to set the allowed * these messages are not printed. If you need to set the allowed
* domains at runtime, use [func@GLib.log_writer_default_set_debug_domains]. * domains at runtime, use [func@GLib.log_writer_default_set_debug_domains].
* *
* `stderr` is used for levels [flags@GLib.LogLevelFlags.ERROR], * `stderr` is used for levels [flags@GLib.LogLevelFlags.LEVEL_ERROR],
* [flags@GLib.LogLevelFlags.CRITICAL], [flags@GLib.LogLevelFlags.WARNING] and * [flags@GLib.LogLevelFlags.LEVEL_CRITICAL], [flags@GLib.LogLevelFlags.LEVEL_WARNING] and
* [flags@GLib.LogLevelFlags.MESSAGE]. `stdout` is used for * [flags@GLib.LogLevelFlags.LEVEL_MESSAGE]. `stdout` is used for
* the rest, unless `stderr` was requested by * the rest, unless `stderr` was requested by
* [func@GLib.log_writer_default_set_use_stderr]. * [func@GLib.log_writer_default_set_use_stderr].
* *