bugfindutils - Bugs: bug #59963, Issues in findutils man pages

 
 

bug #59963: Issues in findutils man pages

Submitted by:  Helge Kreutzmann <kreutzm>
Submitted on:  Thu 28 Jan 2021 04:46:16 PM UTC  
 
Category:  documentation Severity:  3 - Normal
Item Group:  None Status:  Fixed
Privacy:  Public Assigned to:  Bernhard Voelker <berny>
Originator Name:  Open/Closed:  Open
Release:  None Fixed Release:  None

Add a New Comment (Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

( Jump to the original submission)

Sun 31 Jan 2021 06:34:30 PM UTC, comment #8: 

Thanks, pushed:

- find.1: fix some formatting issues
  https://git.sv.gnu.org/cgit/findutils.git/commit/?id=7ed26e1731

- doc: show environment variables in a consistent style
  https://git.sv.gnu.org/cgit/findutils.git/commit/?id=bb0c81f66b

Marking this as fixed.

Bernhard Voelker <berny>
Project AdministratorIn charge of this item.
Sun 31 Jan 2021 06:25:20 PM UTC, comment #7: 

From my side: Yes

Helge Kreutzmann <kreutzm>
Sun 31 Jan 2021 06:21:54 PM UTC, comment #6: 

I've squashed these 2 fixes into one patch - see attached ''0001-find.1-fix-some-formatting-issues.patch.
Okay to push?

(file #50815)

Bernhard Voelker <berny>
Project AdministratorIn charge of this item.
Sun 31 Jan 2021 05:13:07 PM UTC, comment #5: 

Well, the B<> makes the letter bold, so at least on my terminal it looks visually distinct.

However, if you don't like this, having only quotes is surely an option, without using additional markup.

Helge Kreutzmann <kreutzm>
Sun 31 Jan 2021 04:41:53 PM UTC, comment #4: 

Thank you for the fast reply.

> I would expect I<'\\(ti'> -> B<\\(ti>


Hmm, IMO the tilde character alone looks quite odd.
Other examples of a single character in the find.1 man page
also quote, but with `...' style.

What about this?

diff --git a/find/find.1 b/find/find.1
index 96fb1fc7..da0ce9b8 100644
--- a/find/find.1
+++ b/find/find.1
@@ -2341,10 +2341,8 @@ to
.IR /dest-dir ,
but omit files and directories named
.I .snapshot
-(and anything in them).  It also omits files or directories whose name
-ends in
-.IR '\(ti' ,
-but not their contents.
+(and anything in them).  It also omits files or directories whose name ends in
+`\(ti', but not their contents.
.nf
\&
.in +4m

Bernhard Voelker <berny>
Project AdministratorIn charge of this item.
Sun 31 Jan 2021 12:02:01 PM UTC, comment #3: 

Hello Bernhard,
first of all, I'm fine for pushing in my name.

comment #2:

> P.S.:
>
> > Man page: find.1
> > Issue: Quotes around I<>? (for the \\(ti) and I<> → B<>
>
> I don't see what's wrong in this one.  The tilde '~' is meant
> in the context of a file name, therefore italic is correct.
> Maybe there's an issue with the PO conversion?


Well, in Debian Testing I see the quote in the rendered man page as well. I would expect
I<'\\(ti'> -> B<\\(ti>

Helge Kreutzmann <kreutzm>
Sun 31 Jan 2021 11:37:04 AM UTC, comment #2: 

P.S.:

> Man page: find.1
> Issue: Quotes around I<>? (for the \\(ti) and I<> → B<>


I don't see what's wrong in this one.  The tilde '~' is meant
in the context of a file name, therefore italic is correct.
Maybe there's an issue with the PO conversion?

Bernhard Voelker <berny>
Project AdministratorIn charge of this item.
Sun 31 Jan 2021 11:07:39 AM UTC, comment #1: 

Thanks for the report.

> Man page: find.1
> Issue: FIXME B<stat(2)> → B<stat>(2)


I've wrapped the fix into '0001-find.1-fix-formatting-when-referring-to-stat-2.patch' in your name.
Okay to push in your name?

> Man page: find.1
> Issue: POSIXLY_CORRECT → B<POSIXLY_CORRECT>


The formatting of environment variables both in the man page
and the Texinfo manual was not consistent.
The attached '0002-doc-show-environment-variables-in-a-consistent-style.patch' fixes it.

(file #50812, file #50813)

Bernhard Voelker <berny>
Project AdministratorIn charge of this item.
Thu 28 Jan 2021 04:46:16 PM UTC, original submission:  

Dear findutils maintainer,
the manpage-l10n project maintains a large number of translations of
man pages both from a large variety of sources (including Findutils) as
well for a large variety of target languages.

During their work translators notice different possible issues in the
original (english) man pages. Sometimes this is a straightforward
typo, sometimes a hard to read sentence, sometimes this is a
convention not held up and sometimes we simply do not understand the
original.

We use several distributions as sources and update regularly (at
least every 2 month). This means we are fairly recent (some
distributions like archlinux also update frequently) but might miss
the latest upstream version once in a while, so the error might be
already fixed. We apologize and ask you to close the issue immediately
if this should be the case, but given the huge volume of projects and
the very limited number of volunteers we are not able to double check
each and every issue.

Secondly we translators see the manpages in the neutral po format,
i.e. converted and harmonized, but not the original source (be it man,
groff, xml or other). So we cannot provide a true patch (where
possible), but only an approximation which you need to convert into
your source format.

Finally the issues I'm reporting have accumulated over time and are
not always discovered by me, so sometimes my description of the
problem my be a bit limited - do not hesitate to ask so we can clarify
them.

I'm now reporting the errors for your project. If future reports
should use another channel, please let me know.

Man page: find.1
Issue: FIXME B<stat(2)> → B<stat>(2)

"Find files named B<core> in or below the directory B</tmp> and delete them, "
"processing filenames in such a way that file or directory names containing "
"single or double quotes, spaces or newlines are correctly handled.  The B<-"
"name> test comes before the B<-type> test in order to avoid having to call "
"B<stat(2)> on every file."
--
Man page: find.1
Issue: POSIXLY_CORRECT → B<POSIXLY_CORRECT>

"When POSIXLY_CORRECT is not set, B<-perm >I<+zzz> is treated just like B<-"
"perm >I</zzz> if I<+zzz> is not a valid symbolic mode.  When POSIXLY_CORRECT "
"is set, such constructs are treated as an error."
--
Man page: find.1
Issue: B<stat(2)> → B<stat>(2)

"The B<-name> test comes before the B<-type> test in order to avoid having to "
"call B<stat(2)> on every file."
--
Man page: find.1
Issue: Quotes around I<>? (for the \\(ti) and I<> → B<>

"Copy the contents of I</source-dir> to I</dest-dir>, but omit files and "
"directories named I<.snapshot> (and anything in them).  It also omits files "
"or directories whose name ends in I<'\\(ti'>, but not their contents."

Helge Kreutzmann <kreutzm>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by berny (Updated the item)
  • -email is unavailable- added by kreutzm (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

     

     

    Follow 7 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-01-31 berny Categoryfind => documentation
        StatusCode Review => Fixed
    2021-01-31 berny Attached File- => Added 0001-find.1-fix-some-formatting-issues.patch, #50815
    2021-01-31 berny Attached File- => Added 0001-find.1-fix-formatting-when-referring-to-stat-2.patch, #50812
        Attached File- => Added 0002-doc-show-environment-variables-in-a-consistent-style.patch, #50813
        StatusNone => Code Review
        Assigned toNone => berny

    Back to the top


    Powered by Savane 3.7