[glib/glib-2-72: 8/39] docs: Improve wording in documentation of g_unix_signal_source_new()
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib/glib-2-72: 8/39] docs: Improve wording in documentation of g_unix_signal_source_new()
- Date: Tue, 20 Sep 2022 19:07:38 +0000 (UTC)
commit ab47152bfa2549580856371d0ee0cce839a0d14f
Author: Tom Levy <tomlevy93 gmail com>
Date: Fri Sep 16 08:25:46 2022 +0000
docs: Improve wording in documentation of g_unix_signal_source_new()
- Insert missing word "from".
- Remove space between function name and "()" so syntax highlighting
can recognise it as a function.
- Avoid "you"/"your" when discussing the reentrancy issues of regular
UNIX signal handlers, because it gives the false impression that
these issues are applicable to g_unix_signal_source_new().
Unrelated:
- Fix missing space in documentation of g_signal_new_class_handler().
(cherry-picked from commit eeaef8b950580dd76f1c87748e336453301bae9a)
glib/glib-unix.c | 10 +++++-----
gobject/gsignal.c | 2 +-
2 files changed, 6 insertions(+), 6 deletions(-)
---
diff --git a/glib/glib-unix.c b/glib/glib-unix.c
index 958a9f1f5b..9a148cb8f3 100644
--- a/glib/glib-unix.c
+++ b/glib/glib-unix.c
@@ -203,11 +203,11 @@ g_unix_set_fd_nonblocking (gint fd,
*
* For example, an effective use of this function is to handle `SIGTERM`
* cleanly; flushing any outstanding files, and then calling
- * g_main_loop_quit (). It is not safe to do any of this a regular
- * UNIX signal handler; your handler may be invoked while malloc() or
- * another library function is running, causing reentrancy if you
- * attempt to use it from the handler. None of the GLib/GObject API
- * is safe against this kind of reentrancy.
+ * g_main_loop_quit(). It is not safe to do any of this from a regular
+ * UNIX signal handler; such a handler may be invoked while malloc() or
+ * another library function is running, causing reentrancy issues if the
+ * handler attempts to use those functions. None of the GLib/GObject
+ * API is safe against this kind of reentrancy.
*
* The interaction of this source when combined with native UNIX
* functions like sigprocmask() is not defined.
diff --git a/gobject/gsignal.c b/gobject/gsignal.c
index fb85fd6ba2..1fafcae5db 100644
--- a/gobject/gsignal.c
+++ b/gobject/gsignal.c
@@ -1547,7 +1547,7 @@ g_signal_new (const gchar *signal_name,
* an object definition, instead the function pointer is passed
* directly and can be overridden by derived classes with
* g_signal_override_class_closure() or
- * g_signal_override_class_handler()and chained to with
+ * g_signal_override_class_handler() and chained to with
* g_signal_chain_from_overridden() or
* g_signal_chain_from_overridden_handler().
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]