From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 4619 invoked by alias); 15 Jun 2017 13:19:28 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 4599 invoked by uid 89); 15 Jun 2017 13:19:27 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-6.9 required=5.0 tests=BAYES_00,FREEMAIL_FROM,GIT_PATCH_1,RCVD_IN_DNSWL_NONE,SPF_PASS autolearn=ham version=3.3.2 spammy=Descriptions, H*r:sk:static. X-HELO: mail-it0-f43.google.com Received: from mail-it0-f43.google.com (HELO mail-it0-f43.google.com) (209.85.214.43) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Thu, 15 Jun 2017 13:19:25 +0000 Received: by mail-it0-f43.google.com with SMTP id m62so18164026itc.0 for ; Thu, 15 Jun 2017 06:19:30 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version:content-transfer-encoding; bh=caKe2YWPdKOAPGvmHD3s1cG0++6U5LDiuVnjFyMPPKg=; b=M+5XtCajCFy97/Qb+zfqt9kpl1MWt/KYqE6kzXXbeFIky9K5Dw3PJ1vx0DGPtaDy5L 7UBl68A6WFqOzIuwk/SMCLEVHnS6KSugLiDDH2OVeIV7UHRA7I+Io7yDYtLKiiUI4P3e r2hrvIW4LYwSiC/lbvTWIGgicpdFffKtSW7BSG/bw2jeasbW9MW7Js5qENnZiA6GGsaH /f/BJNe7ZruD7q7YWAb9h1t5Dq1YTzTSLI/JtQt9C1B9XDqgamewUUnAJHlMtlTrRLiS MEfdRGmIo8bcD0671IGM36v+zDVJSa+57lVtkWZeO/07sBtt1mz1g/7XARUmu9xN3CDn 3Orw== X-Gm-Message-State: AKS2vOzR5aykSYl5vVY1J5P4Lpe2C3ibz5hvhJO3eJXvNyuYf/3AuPLh 3PJ/x67c0lrZGwQw X-Received: by 10.36.125.145 with SMTP id b139mr5390746itc.51.1497532768837; Thu, 15 Jun 2017 06:19:28 -0700 (PDT) Received: from E107787-LIN (static.42.136.251.148.clients.your-server.de. [148.251.136.42]) by smtp.gmail.com with ESMTPSA id w16sm86142iod.26.2017.06.15.06.19.27 (version=TLS1_2 cipher=AES128-SHA bits=128/128); Thu, 15 Jun 2017 06:19:28 -0700 (PDT) From: Yao Qi To: Eli Zaretskii Cc: gdb-patches@sourceware.org Subject: Re: [PATCH 06/25] Generate c for feature instead of tdesc References: <1497256916-4958-1-git-send-email-yao.qi@linaro.org> <1497256916-4958-7-git-send-email-yao.qi@linaro.org> <837f0h5kjz.fsf@gnu.org> <86wp8gccqv.fsf@gmail.com> <83h8zk3pu3.fsf@gnu.org> <86k24fdhvf.fsf@gmail.com> <83efun520e.fsf@gnu.org> <867f0ewne7.fsf@gmail.com> <83poe634za.fsf@gnu.org> Date: Thu, 15 Jun 2017 13:19:00 -0000 In-Reply-To: <83poe634za.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 14 Jun 2017 19:32:09 +0300") Message-ID: <86zid9tmle.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-IsSubscribed: yes X-SW-Source: 2017-06/txt/msg00445.txt.bz2 Eli Zaretskii writes: >> Yes. The last sentence is about it, "The created source file is built >> into @value{GDBN}", but I didn't explicitly say GDB needs rebuild. > > I think we should say that. > >> > (In general, since GDB is a compiled program which cannot easily be >> > modified without rebuilding it, I wonder how useful this feature will >> > be. But I'll yield to your expertise on that.) >>=20 >> This command is only used by developers after they add or modify XML >> target descriptions. > > Then I think we should say that as well. > I update the paragraph for this command a little bit, @kindex maint print c-tdesc @r{[}@var{file}@r{]} @item maint print c-tdesc Print the target description (@pxref{Target Descriptions}) as a C source file. By default, the target description is for the current target, but if the optional argument @var{file} is provided, that file is used to produce the description. The @var{file} should be an XML document, of the form described in @ref{Target Description Format}. The created source file is built into @value{GDBN} when @value{GDBN} is built again. This command is used by developers after they add or modify XML target descriptions. >> A question in general, do we really need to document these commands, >> which are used for GDB development, in GDB user manual? These >> commands are "maint print c-tdesc", "maint check xml-descriptions" >> (added by one patch in this series), and "maint selftest". Can we >> remove them from the user manual? > > If we remove them, there will be no place where they are documented, > right? GDB developers are GDB users as well, e.g. I read the manual > quite a lot. > > So I see no reason to remove these commands. We just need to indicate > when a command makes sense only for GDB developers. but GDB users are not GDB developers. Why does user manual documents some commands users never use? IMO, these documents should be documented in GDB internals. --=20 Yao (=E9=BD=90=E5=B0=A7)