From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id 24DFD385E010 for ; Fri, 28 Jan 2022 15:55:19 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 24DFD385E010 Received: from mail-wm1-f72.google.com (mail-wm1-f72.google.com [209.85.128.72]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-98-R1sYgltMOsi5kGfAAhqD7Q-1; Fri, 28 Jan 2022 10:55:17 -0500 X-MC-Unique: R1sYgltMOsi5kGfAAhqD7Q-1 Received: by mail-wm1-f72.google.com with SMTP id l16-20020a7bcf10000000b0034ffdd81e7aso3132369wmg.4 for ; Fri, 28 Jan 2022 07:55:17 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=nUhAECa7wVdmqNLa8B1z8Wt8L5lB9dqyeB3DOEKqmdk=; b=lzroVOt9DyyTto7FOq/QvGO9ws0R1GPghqUxYk2ln6ehxA+BNucwq1gJR6Mr1fHQws RHADl0FSEamxqA68ySSX3RL+2Z6XwD3IeN1lfLHvQCAer9gnW6cRVqeAp2Em15XsSTL9 GHu4P4uSwn77CSZ9NCWn5WRxfHZHlJeIf7BngdOdFro2DG24ZmcSrYuhXq1SwNrTNHpm zAGtpPMxMvzNHDd/v9GnqbJAuo0A9+LKvY5R0HL99eE+5hce6qf7qd9ZCKB2o0XqXkqb 6CG5cmCbzl7Ol1D0qAd9UxQ3ueUPljRGZMex5BuTMHeCFAEA8mINKMowGI9M//mEfubO wPgQ== X-Gm-Message-State: AOAM531wmBODW3QpdB0EQibMM/GcWkRiLNNbm7jA0V84/ItZi/GHE7sl MPuReUiYy/GT2gguyRO7fFO3Jm40QBhaF1x4VWkFi0Eo1D85f6whrjHGa/RaG2ib8BMOrXT0q/f wtoyfNu7sIdk2PEQTwcsZYgD0AD511X/gpI34sx3Wtr+PRT8GWiAa7h6kWveLc4f9D+7+YFxA9A == X-Received: by 2002:a5d:644c:: with SMTP id d12mr7504140wrw.631.1643385315938; Fri, 28 Jan 2022 07:55:15 -0800 (PST) X-Google-Smtp-Source: ABdhPJyZu2u/nSHE6PSdN+Wdoe/70JtbxMgn4HLCGv3rO784+dJq8d4c/WvgA05Yi5okhlu0VtOedw== X-Received: by 2002:a5d:644c:: with SMTP id d12mr7504119wrw.631.1643385315634; Fri, 28 Jan 2022 07:55:15 -0800 (PST) Received: from localhost (host86-140-92-93.range86-140.btcentralplus.com. [86.140.92.93]) by smtp.gmail.com with ESMTPSA id n26sm2451041wms.13.2022.01.28.07.55.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 28 Jan 2022 07:55:15 -0800 (PST) From: Andrew Burgess To: gdb-patches@sourceware.org Cc: Andrew Burgess Subject: [PATCH 2/7] gdb/doc: update docs for 'info win' and 'winheight' commands Date: Fri, 28 Jan 2022 15:55:03 +0000 Message-Id: <3ad77c3f3ab06638bb9dd8d37818b0d09af46865.1643385021.git.aburgess@redhat.com> X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII" X-Spam-Status: No, score=-11.7 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 28 Jan 2022 15:55:20 -0000 This started by noticing that the docs for 'winheight' are out of date, the docs currently give a specific list of possible window names. However, now that windows can be implemented in Python, it is not possible to list all possible names. I now link the user to a mechanism by which they can discover the valid names for themselves at run time (by using 'info win'). That, and the fact that gdb provides tab-completion of the name at the command line, feels good enough. Finally, I noticed that the docs for 'win info' don't explicitly say that the name of the window is given in the output. This could probably have been inferred, but given I'm now linking to this as a mechanism to find the window name, I'd prefer to mention that the name can be found in the output. --- gdb/doc/gdb.texinfo | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index fe81687a66c..e72fa4aaaae 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -28812,9 +28812,10 @@ @kindex tui disable Disable TUI mode, returning to the console interpreter. +@anchor{info_win_command} @item info win @kindex info win -List and give the size of all displayed windows. +List the names and sizes of all currently displayed windows. @item tui new-layout @var{name} @var{window} @var{weight} @r{[}@var{window} @var{weight}@dots{}@r{]} @kindex tui new-layout @@ -28961,11 +28962,11 @@ @item winheight @var{name} +@var{count} @itemx winheight @var{name} -@var{count} @kindex winheight -Change the height of the window @var{name} by @var{count} -lines. Positive counts increase the height, while negative counts -decrease it. The @var{name} parameter can be one of @code{src} (the -source window), @code{cmd} (the command window), @code{asm} (the -disassembly window), or @code{regs} (the register display window). +Change the height of the window @var{name} by @var{count} lines. +Positive counts increase the height, while negative counts decrease +it. The @var{name} parameter can be the name of any currently visible +window. The names of the currently visible windows can be discovered +using @code{info win} (@pxref{info_win_command,,info win}). @end table @node TUI Configuration -- 2.25.4