From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from sa-prd-fep-047.btinternet.com (mailomta30-sa.btinternet.com [213.120.69.36]) by sourceware.org (Postfix) with ESMTPS id C07B5385B52A for ; Thu, 16 Mar 2023 18:55:34 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org C07B5385B52A Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=dronecode.org.uk Authentication-Results: sourceware.org; spf=none smtp.mailfrom=dronecode.org.uk Received: from sa-prd-rgout-002.btmx-prd.synchronoss.net ([10.2.38.5]) by sa-prd-fep-047.btinternet.com with ESMTP id <20230316185533.TMAC13453.sa-prd-fep-047.btinternet.com@sa-prd-rgout-002.btmx-prd.synchronoss.net>; Thu, 16 Mar 2023 18:55:33 +0000 Authentication-Results: btinternet.com; auth=pass (PLAIN) smtp.auth=jonturney@btinternet.com; bimi=skipped X-SNCR-Rigid: 64067E9B012B7A17 X-Originating-IP: [86.139.167.100] X-OWM-Source-IP: 86.139.167.100 (GB) X-OWM-Env-Sender: jonturney@btinternet.com X-VadeSecure-score: verdict=clean score=0/300, class=clean X-RazorGate-Vade: gggruggvucftvghtrhhoucdtuddrgedvhedrvdeftddguddvtdcutefuodetggdotefrodftvfcurfhrohhfihhlvgemuceutffkvffkuffjvffgnffgvefqofdpqfgfvfenuceurghilhhouhhtmecufedtudenucesvcftvggtihhpihgvnhhtshculddquddttddmnecujfgurhepkfffgggfuffvfhfhjggtgfesthejredttdefjeenucfhrhhomheplfhonhcuvfhurhhnvgihuceojhhonhdrthhurhhnvgihsegurhhonhgvtghouggvrdhorhhgrdhukheqnecuggftrfgrthhtvghrnhepjeduveejteehgfeivefgudelhfduuddtledugefhkeeifffffefhhfdvgfehgfetnecuffhomhgrihhnpehgihhthhhusgdrtghomhdpghhnuhdrohhrghenucfkphepkeeirddufeelrdduieejrddutddtnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehhvghloheplgduledvrdduieekrddurddutdeingdpihhnvghtpeekiedrudefledrudeijedruddttddpmhgrihhlfhhrohhmpehjohhnrdhtuhhrnhgvhiesughrohhnvggtohguvgdrohhrghdruhhkpdhnsggprhgtphhtthhopedvpdhrtghpthhtohepnhgvfihlihgssehsohhurhgtvgifrghrvgdrohhrghdprhgtphhtthhopeiihhhushhonhhghhgvsegvshifihhntghomhhpuhhtihhnghdrtghomhdprhgvvhfkrfephhhoshhtkeeiqddufeelqdduieejqddutddtrdhrrghnghgvkeeiqddufeelrdgsthgtvghnthhrrghlphhluhhs rdgtohhmpdgruhhthhgpuhhsvghrpehjohhnthhurhhnvgihsegsthhinhhtvghrnhgvthdrtghomhdpghgvohfkrfepifeupdfovfetjfhoshhtpehsrgdqphhrugdqrhhgohhuthdqtddtvd X-RazorGate-Vade-Verdict: clean 0 X-RazorGate-Vade-Classification: clean Received: from [192.168.1.106] (86.139.167.100) by sa-prd-rgout-002.btmx-prd.synchronoss.net (5.8.814) (authenticated as jonturney@btinternet.com) id 64067E9B012B7A17; Thu, 16 Mar 2023 18:55:33 +0000 Message-ID: <8af0cbfc-b6e0-45e0-7d74-9f575399c8b5@dronecode.org.uk> Date: Thu, 16 Mar 2023 18:55:33 +0000 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101 Thunderbird/102.8.0 Subject: Re: [PATCH] Cygwin: doc: Fix type mismatch in porting.texi Content-Language: en-GB To: Songhe Zhu , "newlib@sourceware.org" References: <20230316025947.63497-1-zhusonghe@eswincomputing.com> From: Jon Turney In-Reply-To: <20230316025947.63497-1-zhusonghe@eswincomputing.com> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-Spam-Status: No, score=-1197.5 required=5.0 tests=BAYES_00,FORGED_SPF_HELO,GIT_PATCH_0,KAM_DMARC_STATUS,KAM_LAZY_DOMAIN_SECURITY,KAM_SHORT,NICE_REPLY_A,RCVD_IN_BARRACUDACENTRAL,RCVD_IN_DNSWL_NONE,SPF_HELO_PASS,SPF_NONE,TXREP 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: On 16/03/2023 02:59, Songhe Zhu wrote: > Issue:newlib/libgloss/doc/porting.texi:570: warning: @ref node name should not contain `.' > newlib/libgloss/doc/porting.texi:747: warning: @ref node name should not contain `.' > newlib/libgloss/doc/porting.texi:938: warning: @ref node name should not contain `.' > > reproduce: > git clone https://github.com/riscv-collab/riscv-gnu-toolchain.git > cd riscv-gnu-toolchain > ./configure --prefix=`pwd`/install --with-arch=rv64gc --with-abi=lp64d --enable-multilib > make -j $(nproc) > > The above issue will happen when executing the build command. This patch eliminates these warnings. > @ref{That},'That' does not contain node; > I think it's just appropriate to use @file here, > @file{file-name},'file-name' support node; > refer:https://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#g_t_0040file From a brief reading of that, it doesn't appear that @file{} supports the 3 argument form, so should the 2nd and 3rd arguments be dropped? This would seem to change the meaning subtly, as it drops the indication that the files in Appendix A are examples. Then again, these uses of @ref alone as a sentence are just ungrammatical. So maybe the correct solution is to give those sections names which don't contain '.' and/or embed these references into sentences which direct the reader to that full example, from which a sample is given below (or whatever the documentation is actually trying to say, I'm not well versed enough in libgloss to know for sure) > --- > libgloss/doc/porting.texi | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > diff --git a/libgloss/doc/porting.texi b/libgloss/doc/porting.texi > index 15f214d02..4a269a970 100644 > --- a/libgloss/doc/porting.texi > +++ b/libgloss/doc/porting.texi > @@ -567,7 +567,7 @@ and then the ROM takes over. Pick a safe vector with no side > effects. Some ROMs have a builtin trap handler just for this case. > @end enumerate > portable between all the m68k based boards we have here. > -@ref{crt0.S,,Example Crt0.S}. > +@file{crt0.S,,Example Crt0.S}. > > > @smallexample > @@ -744,7 +744,7 @@ check a few critical addresses like @code{start}, @code{bss_end}, and > > Here's a breakdown of a linker script for a m68k based target board. > See the file @code{libgloss/m68k/idp.ld}, or go to the appendixes in > -the end of the manual. @ref{idp.ld,,Example Linker Script}. > +the end of the manual. @file{idp.ld,,Example Linker Script}. > > @smallexample > STARTUP(crt0.o) > @@ -935,7 +935,7 @@ sbrk(). @code{malloc()}, @code{calloc()}, and @code{realloc()} all call > @code{sbrk()} at there lowest level. @code{caddr_t} is defined elsewhere > as @code{char *}. @code{RAMSIZE} is presently a compile time option. All > this does is move a pointer to heap memory and check for the upper > -limit. @ref{glue.c,,Example libc support code}. @code{sbrk()} returns a > +limit. @file{glue.c,,Example libc support code}. @code{sbrk()} returns a > pointer to the previous value before more memory was allocated. > > @smallexample