bug#50889: closed (Please improve the documentation for install --compare (-C))

[GNU bug Tracking System]

Your message dated Sat, 9 Apr 2022 13:06:28 +0100
with message-id <fa5afc53-d82a-2a33-acd7-a9b82ca560a6@draigBrady.com>
and subject line Re: bug#50889: Please improve the documentation for install 
--compare (-C)
has caused the debbugs.gnu.org bug report #50889,
regarding Please improve the documentation for install --compare (-C)
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs@gnu.org.)


-- 
50889: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=50889
GNU Bug Tracking System
Contact help-debbugs@gnu.org with problems
> --- Begin Message ---
>
>
>
> Subject: 
>
> Please improve the documentation for install --compare (-C)
>
>
>
>
> Date: 
>
> Wed, 29 Sep 2021 12:09:15 +0100
>
>
>
>
> User-agent: 
>
> Evolution 3.40.4 (3.40.4-1.fc34) 
>
>
>
>
> Hi,
>
> A while back a request was made to improve the documentation of the
> `install --compare` cmd:
>
> https://lists.gnu.org/archive/html/bug-coreutils/2009-09/msg00029.html
>
> It seems the wording in `coreutils.texi` has been updated since
> (https://github.com/coreutils/coreutils/commit/c8ac385299950ba84eb8c33f7e32e4d85b18e3ff
> ) but the manpage and `--help` as of coreutils v8.32 still leave things
> vague:
>
> > compare each pair of source and destination files, and in some cases,
> do not modify the destination at all
>
> Florain Schlichting at the time of the request suggested this wording
> instead:
>
> > compare each pair of source and destination files, and if identical
> (by content, ownership and mode), do not copy to preserve mtime
>
> It looks like a patch was made but somehow never made it into the
> codebase. Please could the manpage and help be updated with this
> wording so users can understand more readily what compare will do?
>
> Thanks
>
> Ian
>
>
>
>
> --- End Message ---

--- Begin Message --- Subject: Re: bug#50889: Please improve the documentation for install --compare (-C) Date: Sat, 9 Apr 2022 13:06:28 +0100 User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:97.0) Gecko/20100101 Thunderbird/97.0

On 29/09/2021 12:09, Ian Cross via GNU coreutils Bug Reports wrote:

Hi,

A while back a request was made to improve the documentation of the
`install --compare` cmd:

https://lists.gnu.org/archive/html/bug-coreutils/2009-09/msg00029.html

It seems the wording in `coreutils.texi` has been updated since
(https://github.com/coreutils/coreutils/commit/c8ac385299950ba84eb8c33f7e32e4d85b18e3ff
) but the manpage and `--help` as of coreutils v8.32 still leave things
vague:

compare each pair of source and destination files, and in some cases,

do not modify the destination at all

Florain Schlichting at the time of the request suggested this wording
instead:

compare each pair of source and destination files, and if identical

(by content, ownership and mode), do not copy to preserve mtime

It looks like a patch was made but somehow never made it into the
codebase. Please could the manpage and help be updated with this
wording so users can understand more readily what compare will do?

Both the --help and texinfo was incomplete / confusing.
I've installed the attached to address this.

Marking this as done.

thanks,
Pádraig

install--compare-clarify.patch
Description: Text Data

--- End Message ---