Improve commentary
authorPo Lu <luangruo@yahoo.com>
Wed, 12 Jul 2023 10:04:03 +0000 (18:04 +0800)
committerPo Lu <luangruo@yahoo.com>
Wed, 12 Jul 2023 10:04:03 +0000 (18:04 +0800)
* src/xterm.c (x_ignore_errors_for_next_request): Reword
description of SELECTION_SERIAL.

src/xterm.c

index f84eaeb8cbd23f4e6d444da2ebe04365954a5d13..d65a6829b456fe6b3cf10d75af61c546fa7bacd6 100644 (file)
@@ -25848,10 +25848,12 @@ x_clean_failable_requests (struct x_display_info *dpyinfo)
                                    + (last - first));
 }
 
-/* Protect a section of X requests: ignore errors generated by X
-   requests made from now until `x_stop_ignoring_errors'.  Each call
-   must be paired with a call to `x_stop_ignoring_errors', and
-   recursive calls inside the protected section are not allowed.
+/* Protect a section of X requests.
+
+   Ignore errors generated by X requests made from now until
+   `x_stop_ignoring_errors'.  Each call must be paired with a call to
+   `x_stop_ignoring_errors', and recursive calls inside the protected
+   section are not allowed.
 
    The advantage over x_catch_errors followed by
    x_uncatch_errors_after_check is that this function does not sync to
@@ -25859,11 +25861,10 @@ x_clean_failable_requests (struct x_display_info *dpyinfo)
    those two functions for catching errors around requests that do not
    require a reply.
 
-   As a special feature intended to support xselect.c,
-   SELECTION_SERIAL may be an arbitrary number greater than zero: when
-   that is the case, x_select_handle_selection_error is called with
-   the specified number to delete the selection request that
-   encountered the error.  */
+   If SELECTION_SERIAL is an arbitrary number greater than zero,
+   x_select_handle_selection_error is called with the specified number
+   after any errors within the protected section are received to
+   delete the selection request that encountered errors.  */
 
 void
 x_ignore_errors_for_next_request (struct x_display_info *dpyinfo,