From patchwork Mon Jul 6 13:15:39 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Burgess X-Patchwork-Id: 7528 Received: (qmail 56694 invoked by alias); 6 Jul 2015 13:15:50 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 56367 invoked by uid 89); 6 Jul 2015 13:15:49 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=0.4 required=5.0 tests=AWL, BAYES_50, KAM_LAZY_DOMAIN_SECURITY, RCVD_IN_DNSWL_LOW autolearn=no version=3.3.2 X-HELO: mail-wi0-f171.google.com Received: from mail-wi0-f171.google.com (HELO mail-wi0-f171.google.com) (209.85.212.171) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES128-GCM-SHA256 encrypted) ESMTPS; Mon, 06 Jul 2015 13:15:48 +0000 Received: by wiga1 with SMTP id a1so228556183wig.0 for ; Mon, 06 Jul 2015 06:15:45 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=qIECWTRFvsjQBxksNkZayHdwsAMH1SaN3Kptzjnp/T8=; b=eA0SHzKL5E6PfIdMqJSXZo9NzDUrSS9Y66/8zaZb84QtwvG0n+rcPx2cdtxoWmtB8V gySE43mQAhoDov/QQsmVZD2/fAOx6Png/PTfoq94IuSaooewM2831uQC5SsccnJmpKma XyIznGyxsXGI7IPaJl3zomvdhGMXJYcrJUgJj091CLQi0SevogaxmjzxWI7AivxyAlOt TWlLvprgt1Veztgwrl7TpoDHupHWovgarq2zuz9P6hjIkZN/RQMnGCM3rk/NMfsw9dry tAi+pjb+gtSyOMpIzdQU4CeTvqpJHt3jG+keadsB3u+Pb8280m7q6q3LhqkILfnIAuSV QmEw== X-Gm-Message-State: ALoCoQlzkYdRHi83aQiu0X15cnUsmUuOVjY/bdmCiYe12Ria/xtXYxI8fSJIve4IMeXu8IQKyRXg X-Received: by 10.194.171.129 with SMTP id au1mr100434276wjc.115.1436188545553; Mon, 06 Jul 2015 06:15:45 -0700 (PDT) Received: from localhost (host81-131-205-201.range81-131.btcentralplus.com. [81.131.205.201]) by mx.google.com with ESMTPSA id ul1sm28102060wjc.30.2015.07.06.06.15.43 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 06 Jul 2015 06:15:44 -0700 (PDT) From: Andrew Burgess To: gdb-patches@sourceware.org Cc: Andrew Burgess Subject: [PATCH] gdb: Rewrite documentation for layout and focus commands. Date: Mon, 6 Jul 2015 14:15:39 +0100 Message-Id: X-IsSubscribed: yes The following patch changes the documentation for the layout and focus commands. Though I have extended the documentation for layout slightly most of this patch is really about reformatting the layout of the documentation. The change is really just my personal preference, but I think the new layout is clearer, do people agree? Thanks, Andrew --- Changes the documentation for the layout and focus commands. Instead of documenting each layout (or focus) sub-command as a separate command, document a single layout (and focus) command which takes a parameter, then list the possible parameters in a table nested under each command. The documentation for the layout command has been extended little to make it clearer which windows are shown in each layout. gdb/ChangeLog: * doc/gdb.texinfo (TUI): Restructure documentation on TUI layout and focus commands. --- gdb/ChangeLog | 5 +++++ gdb/doc/gdb.texinfo | 49 +++++++++++++++++++++++++++++++++---------------- 2 files changed, 38 insertions(+), 16 deletions(-) diff --git a/gdb/ChangeLog b/gdb/ChangeLog index 201af51..bbc0291 100644 --- a/gdb/ChangeLog +++ b/gdb/ChangeLog @@ -1,3 +1,8 @@ +2015-07-06 Andrew Burgess + + * doc/gdb.texinfo (TUI): Restructure documentation on TUI layout + and focus commands. + 2015-07-02 Kevin Buettner * rx-tdep.c (RX_USP_REGNUM, RX_BPC_REGNUM): New constants. diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 812917b..509e1db 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -25070,43 +25070,60 @@ Disable TUI mode, returning to the console interpreter. @kindex info win List and give the size of all displayed windows. -@item layout next +@item layout @var{name} @kindex layout +Changes which TUI windows are displayed. In each layout the command +window is always displayed, the value of @var{name} controls which +additional windows are also displayed, and can be any of the +following: + +@table @code +@item next Display the next layout. -@item layout prev +@item prev Display the previous layout. -@item layout src -Display the source window only. +@item src +Display the source and command windows. -@item layout asm -Display the assembly window only. +@item asm +Display the assembly and command windows. -@item layout split -Display the source and assembly window. +@item split +Display the source, assembly, and command windows. -@item layout regs -Display the register window together with the source or assembly window. +@item regs +When in @code{src} or @code{asm} layout the register window is +displayed in addition to the existing source or assembler window. +When in @code{split} layout then the register and assembler windows +are displayed. The command window is always displayed. +@end table -@item focus next +@item focus @var{name} @kindex focus +Changes which TUI window is currently active for scrolling. The value +of @var{name} can be any of the following: + +@table @code +@item next Make the next window active for scrolling. -@item focus prev +@item prev Make the previous window active for scrolling. -@item focus src +@item src Make the source window active for scrolling. -@item focus asm +@item asm Make the assembly window active for scrolling. -@item focus regs +@item regs Make the register window active for scrolling. -@item focus cmd +@item cmd Make the command window active for scrolling. +@end table @item refresh @kindex refresh