Misleading information in "man cmp". Easily correctable.

Bug #294998 reported by Ganton
8
Affects Status Importance Assigned to Milestone
diffutils (Ubuntu)
Confirmed
Undecided
Unassigned

Bug Description

If you execute
 man cmp
it says inside that you can execute
 info diff
but that goes directly to show information about "diff".

On the other hand
 info cmp
goes directly to show information about "cmp".

Revision history for this message
Anthony Noto (angusthefuzz) wrote :

Thank you for filing this bug report and helping to make ubuntu better. I agree that this is misleading and I am marking the bug as confirmed.

parvathy (pars1987)
Changed in diffutils:
assignee: nobody → pars1987
Revision history for this message
Shawn Ligocki (sligocki) wrote :

This is not a typo.

The first lines of "info diff" are:

   This file documents the the GNU `diff', `diff3', `sdiff', and `cmp'
commands for showing the differences between text files and the `patch'
command for using their output to update files.

However, you need the "diff-doc" package to get the the actual infopage. Without this package, info looks at the manpage instead (which only covers diff).

Changed in diffutils (Ubuntu):
assignee: pars1987 → nobody
status: Confirmed → Invalid
Revision history for this message
Ganton (ganton) wrote :

Use case: Jane writes "man cmp" and there she is told to write "info diff" and there she is told nothing about "cmp".

> However, you need the "diff-doc" package to get the the actual infopage.
Then Jane has to be told so, don't anyone think? Is Jane supposed to foretell it?

How can anyone say this bug is invalid?

So it's correct this way? Nothing has to be changed?

Revision history for this message
Shawn Ligocki (sligocki) wrote :

>> However, you need the "diff-doc" package to get the the actual infopage.
> Then Jane has to be told so, don't anyone think? Is Jane supposed to foretell it?
You make a good point. Sorry for the rash action. This should be clarified in the man page.

The solution to this documentation issue is *not* to change "info diff" to "info cmp" because there is no Texinfo manual for cmp.

Instead, the SEE ALSO section should be editted to say something like:

--
The full documentation for cmp is maintained as a Texinfo manual. To access this manual, you must have the Ubuntu diff-doc package installed. You can do so with the command

        apt-get install diff-doc

Once you have the package instlalled, run the command

        info diff

to get access to the complete manual.
--

What do you guys think?

Changed in diffutils (Ubuntu):
status: Invalid → Confirmed
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.