From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id N+vKOUvkZmEDBQAAWB0awg (envelope-from ) for ; Wed, 13 Oct 2021 09:51:07 -0400 Received: by simark.ca (Postfix, from userid 112) id D6A0B1F0BB; Wed, 13 Oct 2021 09:51:07 -0400 (EDT) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on simark.ca X-Spam-Level: X-Spam-Status: No, score=-0.7 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,MAILING_LIST_MULTI,RDNS_DYNAMIC,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.2 Received: from sourceware.org (ip-8-43-85-97.sourceware.org [8.43.85.97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by simark.ca (Postfix) with ESMTPS id 944AA1ECEB for ; Wed, 13 Oct 2021 09:51:03 -0400 (EDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 162313858411 for ; Wed, 13 Oct 2021 13:51:03 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 162313858411 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1634133063; bh=y1mBm5H3eV1oEqaRo9d2f+q7rJkULvWoPmnSg8lcekk=; h=Date:To:In-Reply-To:Subject:References:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc: From; b=SVOXOK0vENcHsgAfL3DWbTKxzuhC1oTDgazdOvpkgBCCkTasm/T8ih6aoQVT709WP /WsYxs0dC4Ej2pP3FqAYfQpNkd4LJBvEa/M5DcxVjs2mH9B9wTPHhrwr2frdaboGRC X9JnxnyQGXm0beEX0qqg0ph2fh+HvRaTG9H49j2I= Received: from eggs.gnu.org (eggs.gnu.org [IPv6:2001:470:142:3::10]) by sourceware.org (Postfix) with ESMTPS id 61D3B3858403 for ; Wed, 13 Oct 2021 13:50:41 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 61D3B3858403 Received: from fencepost.gnu.org ([2001:470:142:3::e]:32970) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1maeeW-0002jF-IY; Wed, 13 Oct 2021 09:50:40 -0400 Received: from [87.69.77.57] (port=4645 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1maee8-00076n-Rm; Wed, 13 Oct 2021 09:50:28 -0400 Date: Wed, 13 Oct 2021 16:50:10 +0300 Message-Id: <83bl3tniel.fsf@gnu.org> To: Bruno Larsen In-Reply-To: <20211013130409.10711-1-blarsen@redhat.com> (message from Bruno Larsen via Gdb-patches on Wed, 13 Oct 2021 10:04:09 -0300) Subject: Re: [PATCH] [gdb/doc]: Updated manpages to be consistent with help References: <20211013130409.10711-1-blarsen@redhat.com> 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: , From: Eli Zaretskii via Gdb-patches Reply-To: Eli Zaretskii Cc: gdb-patches@sourceware.org Errors-To: gdb-patches-bounces+public-inbox=simark.ca@sourceware.org Sender: "Gdb-patches" > Date: Wed, 13 Oct 2021 10:04:09 -0300 > From: Bruno Larsen via Gdb-patches > > Updated manpages to be consistent with help information provided by the > binary. The main changes are Making all long-form options have '--', > instead of a single '-' and added most of the missing options to the > manpage. Thanks. The replacement of '-' by '--' are mechanical and don't need any approval. Many other changes replace something like this: Use @file{file} as SOMETHING. with something like this: Use file @file{somefile} as SOMETHING. I must confess that I prefer the former form, because it makes the text more concise and easier to read, by avoiding one more "file". > -@item -nh > +@item --directory=@var{DIR} > +@itemx -d @var{DIR} > +Add @var{DIR} to the path to search for source files. The string inside @var{..} should never be upper-case. (Yes, I know this was in the original text.) Also, here I'd prefer Add @var{directory} to the path to search for source files. because "DIR" doesn't necessarily speak for its being a directory. > -@item -cd=@var{directory} > -Run @value{GDBN} using @var{directory} as its working directory, > +@item --batch-silent > +Run in batch mode, just like @option{--batch}, but totally silent. All @value{GDBN} > +output is supressed (stderr is unaffected). This is much quieter than ^^ Two spaces between sentences, please. > +This is particularly useful when using targets that give 'Loading section' ^^^^^^^^^^^^^^^^^ This should be in @samp, not in literal quotes. > +Note that targets that give their ourpur via GDB, as opposed to writting ^^^ @value{GDBN} > +directly to stdout, will also be made silent. "stdout" should be in @code. Or use "standard output" instead. > +@item --args @var{prog} [@var{arglist}] > +Change interpretation of command line so that arguments following this > +option are passed as arguments to the inferior. As an example, take ^^ Two spaces. > +Will start GDB with @option{-q}, not printing the introductory message. On ^^^ ^^ @value{GDBN}, and two spaces. > +Starts GDB with the introductory message, and passes the option to the inferior. @value{GDBN} > +@item --pid=@var{PID} > +Attach GDB to an already running program, with the PID @var{PID}. Likewise. Also, @var{PID} should be @var{pid}. > +@item --configuration > +Prints details about GDB configuration and then exit. @value{GDBN} > +@item --cd=@var{DIR} > +Run @value{GDBN} using @var{DIR} as its working directory, > instead of the current directory. Please replace "DIR" with "directory". > -@item -fullname > +@item --data-directory=@var{DIR} > +@item -D > +Run @value{GDBN} using @var{DIR} as its data directory. The data > +directory is where @value{GDBN} searches for its auxiliary files. Likewise. > -@item -b @var{bps} > +@item -b @var{BAUDRATE} Uppercase @var again. > -@item -tty=@var{device} > +@item -l @var{TIMEOUT} > +Set timeout, in seconds, for remote debugging. And here. Thanks.