libgloss: doc: fix dir info entry usage

Message ID 20231227005026.18579-1-vapier@gentoo.org
State New
Headers
Series libgloss: doc: fix dir info entry usage |

Commit Message

Mike Frysinger Dec. 27, 2023, 12:50 a.m. UTC
  Wrapping the dir info with @ifnottex means it's included in all other
outputs like html which makes no sense.  Switch to @direntry which is
specific for this content and is automatically written to the output
that makes sense, and omitted from the rest.
---
 libgloss/doc/porting.texi | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
  

Comments

Mike Frysinger Jan. 20, 2024, 12:50 a.m. UTC | #1
On 26 Dec 2023 19:50, Mike Frysinger wrote:
> Wrapping the dir info with @ifnottex means it's included in all other
> outputs like html which makes no sense.  Switch to @direntry which is
> specific for this content and is automatically written to the output
> that makes sense, and omitted from the rest.

ping ...

(and the other doc update patches too)
-mike
  
Corinna Vinschen Jan. 22, 2024, 9:58 a.m. UTC | #2
Hi Mike,

On Jan 19 19:50, Mike Frysinger wrote:
> On 26 Dec 2023 19:50, Mike Frysinger wrote:
> > Wrapping the dir info with @ifnottex means it's included in all other
> > outputs like html which makes no sense.  Switch to @direntry which is
> > specific for this content and is automatically written to the output
> > that makes sense, and omitted from the rest.
> 
> ping ...
> 
> (and the other doc update patches too)
> -mike

just push them.


Thanks,
Corinna
  
Mike Frysinger Jan. 23, 2024, 3:17 a.m. UTC | #3
On 22 Jan 2024 10:58, Corinna Vinschen wrote:
> On Jan 19 19:50, Mike Frysinger wrote:
> > On 26 Dec 2023 19:50, Mike Frysinger wrote:
> > > Wrapping the dir info with @ifnottex means it's included in all other
> > > outputs like html which makes no sense.  Switch to @direntry which is
> > > specific for this content and is automatically written to the output
> > > that makes sense, and omitted from the rest.
> > 
> > ping ...
> > 
> > (and the other doc update patches too)
> 
> just push them.

thx, i pushed all but one i posted as RFC, so if you could check it:
https://sourceware.org/pipermail/newlib/2023/020842.html
-mike
  

Patch

diff --git a/libgloss/doc/porting.texi b/libgloss/doc/porting.texi
index 5697a64d0b46..e3c48845da37 100644
--- a/libgloss/doc/porting.texi
+++ b/libgloss/doc/porting.texi
@@ -43,12 +43,13 @@  Permission is granted to copy and distribute translations of this manual
 into another language, under the above conditions for modified versions.
 @end titlepage
 
-@ifnottex
-@format
+@direntry
 START-INFO-DIR-ENTRY
 * Embed with GNU: (porting-).         Embed with GNU
 END-INFO-DIR-ENTRY
-@end format
+@end direntry
+
+@ifnottex
 Copyright (c) 1993, 1994, 1995 Cygnus Support
 
 Permission is granted to make and distribute verbatim copies of