GNU bug report logs - #50889
Please improve the documentation for install --compare (-C)

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 50889 in the body.
You can then email your comments to 50889 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Ian Cross <ian.cross <at> galagic.com>
To: bug-coreutils <at> gnu.org
Subject: Please improve the documentation for install --compare (-C)
Date: Wed, 29 Sep 2021 12:09:15 +0100

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

Message #10 received at 50889-done <at> debbugs.gnu.org (full text, mbox):

From: Pádraig Brady <P <at> draigBrady.com>
To: Ian Cross <ian.cross <at> galagic.com>, 50889-done <at> debbugs.gnu.org
Subject: Re: bug#50889: Please improve the documentation for install --compare
 (-C)
Date: Sat, 9 Apr 2022 13:06:28 +0100

[Message part 1 (text/plain, inline)]

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 (text/x-patch, attachment)]

Message #13 received at 50889-done <at> debbugs.gnu.org (full text, mbox):

From: Ian Cross <ian.cross <at> galagic.com>
To: Pádraig Brady <P <at> draigBrady.com>, 
 50889-done <at> debbugs.gnu.org
Subject: Re: bug#50889: Please improve the documentation for install
 --compare (-C)
Date: Thu, 05 May 2022 12:22:04 +0100

Wonderful, many thanks!

Ian.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.