Re: Redundant @deffnx and typo in manual
Bernhard Voelker <[email protected]>
| Newsgroups | gmane.comp.gnu.findutils.bugs |
|---|---|
| Message-ID | <[email protected]> |
Hi Antonio, On 11/15/22 19:55, Antonio Diaz Diaz wrote: > Hello. > > I have found a couple minor bugs in the manuals of findutils 4.9.0. > > Line 389 of find.texi seems to be redundant: > > 388 @deffn Option -files0-from file > 389 @deffnx Option -files0-from file Good catch! See 0001-doc-remove-redundant-deffnx-for-option-files0-from-f.patch > In line 950 of find-maint.texi there is a typo: s/p[art/part/ > > 950 The GNU findutils mantainer has issued a patch as p[art of this > 951 announcement. The patch appears below. And another old one. See 0002-doc-fix-typo-in-maintainer-manual.patch > It would also be nice to pass the option "--no-split" to makeinfo, because > the find.info manual is barely larger than 300 kB and is split in three > unequal parts with one of them containing about 94% of the whole manual. Good suggestion. See 0003-doc-generate-manuals-with-makeinfo-no-split.patch Good to push (with the first 2 in your name)? Thanks & have a nice day, Berny
0001-doc-remove-redundant-deffnx-for-option-files0-from-f.patch
(text/x-patch, 880 B)
From 8ff8307fd60a238c620ffdbec3d94792c1de6cf0 Mon Sep 17 00:00:00 2001 From: Antonio Diaz Diaz <[email protected]> Date: Wed, 16 Nov 2022 00:25:39 +0100 Subject: [PATCH 1/3] doc: remove redundant @deffnx for option -files0-from from manual * doc/find.texi (section Starting points): Remove @deffnx; the @deffn above it is sufficient. Copyright-paperwork-exempt: Yes --- doc/find.texi | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/find.texi b/doc/find.texi index 1f295837..379fe646 100644 --- a/doc/find.texi +++ b/doc/find.texi @@ -386,7 +386,6 @@ Alternatively, it is generally safe though non-portable to use the GNU option @samp{-files0-from} to pass arbitrary starting points to @code{find}. @deffn Option -files0-from file -@deffnx Option -files0-from file Read the starting points from @file{file} instead of getting them on the command line. -- 2.38.1
0002-doc-fix-typo-in-maintainer-manual.patch
(text/x-patch, 941 B)
From f9f1ffc85058c90e1654292038d61f26819009b2 Mon Sep 17 00:00:00 2001 From: Antonio Diaz Diaz <[email protected]> Date: Wed, 16 Nov 2022 00:30:38 +0100 Subject: [PATCH 2/3] doc: fix typo in maintainer manual * doc/find-maint.texi (chapter Security): s/p[art/part/ Copyright-paperwork-exempt: Yes --- doc/find-maint.texi | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/find-maint.texi b/doc/find-maint.texi index b1710ee6..e66db9dc 100644 --- a/doc/find-maint.texi +++ b/doc/find-maint.texi @@ -947,7 +947,7 @@ VI. VENDOR RESPONSE The GNU project discovered the problem while 'locate' was being worked on; this is the first public announcement of the problem. -The GNU findutils mantainer has issued a patch as p[art of this +The GNU findutils mantainer has issued a patch as part of this announcement. The patch appears below. A source release of findutils-4.2.31 will be issued on 2007-05-30. -- 2.38.1
0003-doc-generate-manuals-with-makeinfo-no-split.patch
(text/x-patch, 2.5 KB)
From 4391e438a4c947f2f4d89ac65c19722a3dd94195 Mon Sep 17 00:00:00 2001 From: Bernhard Voelker <[email protected]> Date: Wed, 16 Nov 2022 00:54:05 +0100 Subject: [PATCH 3/3] doc: generate manuals with `makeinfo --no-split` * doc/Makefile.am (AM_MAKEINFOFLAGS): Add for --no-split option. (find_mono.html): Remove --no-split from makeinfo invocation. * NEWS (Documentation Changes): Document the change. * doc/.gitignore (/find.info-1,/find.info-2): Remove entries. Suggested by Antonio Diaz Diaz <[email protected]> in https://lists.gnu.org/r/bug-findutils/2022-11/msg00001.html --- NEWS | 5 +++++ doc/.gitignore | 2 -- doc/Makefile.am | 6 +++++- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/NEWS b/NEWS index dffca5aa..1fff34f8 100644 --- a/NEWS +++ b/NEWS @@ -13,6 +13,11 @@ GNU findutils NEWS - User visible changes. -*- outline -*- (allout) findutils now builds again on systems with musl-libc. This requires gettext-0.19.8. +** Documentation Changes + + When generating the Texinfo manual, `makeinfo` is invoked with the --no-split + option for all output formats now; this avoids files like find.info-[12]. + * Noteworthy changes in release 4.9.0 (2022-02-22) [stable] diff --git a/doc/.gitignore b/doc/.gitignore index 5894fa1f..a5451b14 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -9,8 +9,6 @@ /find.fns /find.html/ /find.info -/find.info-1 -/find.info-2 /find.ky /find.log /find.pdf diff --git a/doc/Makefile.am b/doc/Makefile.am index d16ebfa4..47c2f2b2 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -26,6 +26,10 @@ CLEANFILES = find.txt find_mono.html findutils.texi_html_node.tar.gz dblocation. find.txt tmp-doc-install find_mono.html.gz MAKEINFOTXT = $(MAKEINFO) --plaintext +# Tell makeinfo to put everything in a single info file: <package>.info. +# Otherwise, it would also generate files with names like <package>.info-[12]. +AM_MAKEINFOFLAGS = --no-split + find.txt: find.texi $(srcdir)/version.texi $(find_TEXINFOS) # find.txt is a file which we need to know how to build @@ -51,7 +55,7 @@ find.txt: find.texi $(srcdir)/version.texi $(find_TEXINFOS) # This rule is derived from the generic .texi.html rule. find_mono.html: find.texi rm -rf $(@:.html=.htp) - if $(MAKEINFOHTML) --no-split $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ + if $(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ -o $(@:.html=.htp) find.texi; \ then \ rm -rf $@; \ -- 2.38.1