From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 1551) id 7F9E7385608D; Tue, 12 Jul 2022 17:12:01 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 7F9E7385608D Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Pedro Alves To: gdb-cvs@sourceware.org Subject: [binutils-gdb] Improve "set scheduler-locking" documentation X-Act-Checkin: binutils-gdb X-Git-Author: Pedro Alves X-Git-Refname: refs/heads/master X-Git-Oldrev: 3da5576c911a0f3fc608471f1486dc6db11052ef X-Git-Newrev: d21d919bc1d75f89140218f0d5702d0afff41209 Message-Id: <20220712171201.7F9E7385608D@sourceware.org> Date: Tue, 12 Jul 2022 17:12:01 +0000 (GMT) X-BeenThere: gdb-cvs@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-cvs mailing list List-Unsubscribe: , List-Archive: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 12 Jul 2022 17:12:01 -0000 https://sourceware.org/git/gitweb.cgi?p=3Dbinutils-gdb.git;h=3Dd21d919bc1d7= 5f89140218f0d5702d0afff41209 commit d21d919bc1d75f89140218f0d5702d0afff41209 Author: Pedro Alves Date: Tue Nov 30 19:52:11 2021 +0000 Improve "set scheduler-locking" documentation =20 This improves the "set scheduler-locking" documentation in the GDB manual: =20 - Use a table to describe the four available modes. =20 - Describe "step" in terms of "on" and "off". =20 - Tweak the "replay" mode's description to describe replay first instead of recording, and also mention how the mode behaves during normal execution. =20 - Say what is the default mode. =20 Change-Id: Ie12140138b37534b7fc1d904da34f0f174aa11ce Diff: --- gdb/doc/gdb.texinfo | 40 +++++++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 562e4c1f628..9a8b010476a 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -6939,19 +6939,33 @@ locking the OS scheduler to allow only a single thr= ead to run. @cindex scheduler locking mode @cindex lock scheduler Set the scheduler locking mode. It applies to normal execution, -record mode, and replay mode. If it is @code{off}, then there is no -locking and any thread may run at any time. If @code{on}, then only -the current thread may run when the inferior is resumed. The -@code{step} mode optimizes for single-stepping; it prevents other -threads from preempting the current thread while you are stepping, so -that the focus of debugging does not change unexpectedly. Other -threads never get a chance to run when you step, and they are -completely free to run when you use commands like @samp{continue}, -@samp{until}, or @samp{finish}. However, unless another thread hits a -breakpoint during its timeslice, @value{GDBN} does not change the -current thread away from the thread that you are debugging. The -@code{replay} mode behaves like @code{off} in record mode and like -@code{on} in replay mode. +record mode, and replay mode. @var{mode} can be one of +the following: + +@table @code +@item off +There is no locking and any thread may run at any time. + +@item on +Only the current thread may run when the inferior is resumed. + +@item step +Behaves like @code{on} when stepping, and @code{off} otherwise. +Threads other than the current never get a chance to run when you +step, and they are completely free to run when you use commands like +@samp{continue}, @samp{until}, or @samp{finish}. + +This mode optimizes for single-stepping; it prevents other threads +from preempting the current thread while you are stepping, so that the +focus of debugging does not change unexpectedly. However, unless +another thread hits a breakpoint during its timeslice, @value{GDBN} +does not change the current thread away from the thread that you are +debugging. + +@item replay +Behaves like @code{on} in replay mode, and @code{off} in either record +mode or during normal execution. This is the default mode. +@end table =20 @item show scheduler-locking Display the current scheduler locking mode.