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 22F973858D28 for ; Mon, 4 Dec 2023 15:57:19 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 22F973858D28 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 22F973858D28 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1701705440; cv=none; b=glgwTvyzSuNn6YTAzkRd9MD8n4kw6Y4Um0iyxanMFLVzbMxtkkvWWkC95u6ZzI02u45cqo8ZPIzo3gc/IGBn7llzoS8TBKgYYta2wceVp5O+8CU/WVwMHslmT6ZDFTLNimcpczP2GFTrKQcQjOFI9yY8DK97wDvFZfQr4O6Fb2o= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1701705440; c=relaxed/simple; bh=7WbCzTcHFaMU2jQ2MFBfox/aC3H7wQAVQinM/LIQHOQ=; h=DKIM-Signature:From:To:Subject:Date:Message-ID:MIME-Version; b=Y98MJ7hSOxaVyxwqazacwnpUAfBFEdTmaI4zFZulY4A2H/qQvrasmS53iAySdqUqBd3MfM/IY5G/p9w1AVQpmVtv4ItnTnnGrQ8JSlkunaNgZREiR6AW3Ck0B8zLC1tu7GsdZClb6cir/Dy47PR8ZTAbg/oeGmJAWiGbV+X5N5o= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1701705438; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=fKclx6A3vagiBDWI73X1gAvNiaVJhyIEJqt6EPWipDs=; b=c2NMAFCou4LNu6Uvze6fflesqaKX7T01SK1Fu/jcAiEn+IwIc2diKfqLqdrPw8o6uk/u+2 ryrPa4PPFToPqz9ovcCcPsSNUrjdzzpLz+fS4QxYu0PPinMEwn0daFzJfiTjxWpsL/rdGk s392v9JZgRTYJHLIv/q+F6Rr1eEKGUY= Received: from mail-wr1-f71.google.com (mail-wr1-f71.google.com [209.85.221.71]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-284-pT4w2AjNMMuV5TzbnggrSA-1; Mon, 04 Dec 2023 10:57:17 -0500 X-MC-Unique: pT4w2AjNMMuV5TzbnggrSA-1 Received: by mail-wr1-f71.google.com with SMTP id ffacd0b85a97d-33342e25313so1381656f8f.3 for ; Mon, 04 Dec 2023 07:57:17 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1701705436; x=1702310236; h=mime-version:message-id:date:references:in-reply-to:subject:cc:to :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=fKclx6A3vagiBDWI73X1gAvNiaVJhyIEJqt6EPWipDs=; b=musTCcciVOLZIGBrKFccPWjo6ZSoK22WFNL9eGcGQJM/7ypuNl2hpwWe+apzYi+B/r ZOoLOii86/gX63svcRyG/aHZDHazjCQiqZE+ijUU5Z3P1S6/wnR1hpILLHUyM1FOE4i1 Gmnu43l6rVvIRNWSeDWf1OnDEovVj14K24NRe/SyT4gccCCwKDXSCxQmt0PL7qSELGHJ RR2KU85yQLh7/cefkz9mbpkE3UFjTQ0RhjXR1XFjDnb+yegWgEMsWfnW4KB90+HjI2Rg l7ug5TAGJtVbBS3WALWKgwSl+7ctMRpPd24GgM8JPxZAeDiLz2rn4oMxE5KS52LwmQai 9GwA== X-Gm-Message-State: AOJu0Yz2PH4B0RSYWuNo0h/8/QmNhvzD9NooXR4I4dEZr1n6xwggukWY ElAVa1jfi6VeQ+NDs0YB7yiFmgLidZCowbF/LdkbbZwoHqNUObAGadp607tiyUI+rdjE7b8y6b+ DN7DYhskUS0VKI5i1rqLLORymVeLXSw== X-Received: by 2002:adf:f74c:0:b0:333:2fd2:51e4 with SMTP id z12-20020adff74c000000b003332fd251e4mr3751436wrp.93.1701705436538; Mon, 04 Dec 2023 07:57:16 -0800 (PST) X-Google-Smtp-Source: AGHT+IFlbiDSl64on58tvsaorTGlEZEy0979xXw31k4r8/cCb0sD8g3EbzBb4hLbv6OT7APyZLaORQ== X-Received: by 2002:adf:f74c:0:b0:333:2fd2:51e4 with SMTP id z12-20020adff74c000000b003332fd251e4mr3751427wrp.93.1701705436217; Mon, 04 Dec 2023 07:57:16 -0800 (PST) Received: from localhost (105.226.159.143.dyn.plus.net. [143.159.226.105]) by smtp.gmail.com with ESMTPSA id d10-20020a5d538a000000b003332ef77db4sm10402133wrv.44.2023.12.04.07.57.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 04 Dec 2023 07:57:15 -0800 (PST) From: Andrew Burgess To: Eli Zaretskii Cc: gdb-patches@sourceware.org Subject: Re: [PATCH 2/3] gdbserver: allow the --debug command line option to take a value In-Reply-To: <83h6l3avzv.fsf@gnu.org> References: <83v8ad1hcv.fsf@gnu.org> <87bkbbnldv.fsf@redhat.com> <83h6l3avzv.fsf@gnu.org> Date: Mon, 04 Dec 2023 15:57:14 +0000 Message-ID: <87il5egdut.fsf@redhat.com> MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain X-Spam-Status: No, score=-5.7 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_NONE,TXREP,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: Eli Zaretskii writes: >> From: Andrew Burgess >> Cc: gdb-patches@sourceware.org >> Date: Thu, 30 Nov 2023 18:31:24 +0000 >> >> Eli Zaretskii writes: >> >> >> +Each @var{option} is the name of a component for which debugging >> >> +should be enabled. The list of possible options is @option{all}, >> >> +@option{threads}, @option{event-loop}, @option{remote}. The special >> >> +option @option{all} enables all components. The option list is >> >> +processed left to right, and an option can be prefixed with the >> >> +@kbd{-} character to disable output for that component, so you could write: >> >> + >> >> +@smallexample >> >> +target> gdbserver --debug=all,-event-loop >> >> +@end smallexample >> >> + >> >> +@noindent to turn on debug output for all components except @option{event-loop}. >> > >> > Why do we need this duplicate description? I'd prefer to have a short >> > sentence with a cross-reference to the previous description, so that >> > we could have only one of them, not two. >> >> This is unfortunate. One of these instances is the general gdb info >> manual, while the second of these is the gdbserver man page. > > The above is from the manual, and in Texinfo, not from the man page. > How is the man page relevant? The man page is generated from gdb.texinfo using this magic in gdb/doc/Makefile.in: gdbserver.1: $(GDB_DOC_FILES) touch $@ -$(TEXI2POD) $(MANCONF) -Dgdbserver < $(srcdir)/gdb.texinfo > gdbserver.pod -($(POD2MAN1) gdbserver.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) rm -f gdbserver.pod If from a top-level binutils-gdb build directory you do: make -C gdb/doc man you'll then be able to do: man gdb/doc/gdbserver.1 and in that man-page you'll find that one of the blocks of my change are present. Note that my patch doesn't touch any other files in gdb/doc, so we can be sure this is all coming from gdb.texinfo. Similarly, if you: make -C gdb/doc info and then: info gdb/doc/gdb.info and then search for "Man Pages", you'll see that the man-pages for each tool are included in the info manual. Thanks, Andrew > >> I guess we could restructure things somehow so that the man page part is >> used in some way such that the duplication is removed? But that seems >> like a bigger refactoring task; there is already lots of duplication >> between the man page and the info manual, so I think trying to solve the >> problem just for this one option doesn't make much sense. > > I meant duplication in the manual, not between the manual and the man > page.