Bug 424177

Summary:	Typos in man page
Product:	[Applications] kdiff3	Reporter:	justindonnelly
Component:	application	Assignee:	michael <reeves.87>
Status:	RESOLVED FIXED
Severity:	minor
Priority:	NOR
Version First Reported In:	1.8.x
Target Milestone:	---
Platform:	RedHat Enterprise Linux
OS:	Linux
Latest Commit:	https://invent.kde.org/sdk/kdiff3/commit/f4781e60f0cbd1d161b0fea3724b00e441d7d93e	Version Fixed/Implemented In:	1.8.4
Sentry Crash Report:

Description justindonnelly 2020-07-14 02:48:17 UTC

There are a few minor typos in the man page for kdiff3.


STEPS TO REPRODUCE
1. View kdiff3 man page (man kdiff3).

OBSERVED RESULT
1. There is a copy/paste error for the FILE3 parameter description.  It says "file2 to open" instead of "file3 to open".
2. The options for aliases are incorrect.  They are listed as "-L1", "-L2", and "-L3".  They should be "--L1", "--L2", and "--L3".  This mistake is in the SYNOPSIS and the OPTIONS portions of the man page.

The help (kdiff3 --help) does not have these typos.

EXPECTED RESULT
Man page without typos.

SOFTWARE/OS VERSIONS
CentOS 8 (Cent wasn't in the Platform drop-down, so I selected RedHat)
kdiff3 1.8.1

ADDITIONAL INFORMATION
Thanks for providing this useful tool!

Comment 1 michael 2020-07-15 23:30:34 UTC

For #2 the error is actually in the way -L is handled by kdiff3 1.8.1. This is corrected in 1.8.2. I go ahead a fix the other typo.

Comment 2 michael 2020-07-15 23:37:59 UTC

Git commit 0639492ab3bd29b2cf31d55681ab1f05947384ca by Michael Reeves.
Committed on 15/07/2020 at 23:37.
Pushed by mreeves into branch '1.8'.

Fix typo in man page.
FIXED-IN:1.8.4
(cherry picked from commit 9fab7d930972632266cc6528c063e80b24a904e5)

M  +1    -1    doc/en/man-kdiff3.1.docbook

https://invent.kde.org/sdk/kdiff3/commit/0639492ab3bd29b2cf31d55681ab1f05947384ca

Comment 3 michael 2020-07-15 23:37:59 UTC

Git commit 9fab7d930972632266cc6528c063e80b24a904e5 by Michael Reeves.
Committed on 15/07/2020 at 23:34.
Pushed by mreeves into branch 'master'.

Fix typo in man page.
FIXED-IN:1.8.4

M  +1    -1    doc/en/man-kdiff3.1.docbook

https://invent.kde.org/sdk/kdiff3/commit/9fab7d930972632266cc6528c063e80b24a904e5

Comment 4 michael 2020-07-15 23:45:43 UTC

Git commit b4a4502cdd726103cb8ee423c847e6180f4ba440 by Michael Reeves.
Committed on 15/07/2020 at 23:44.
Pushed by mreeves into branch '1.8'.

Sorry mis-reading  Fix second typo
(cherry picked from commit 35c6356ae92551666e208dcc87d96ca74b2c5e09)

M  +3    -3    doc/en/man-kdiff3.1.docbook

https://invent.kde.org/sdk/kdiff3/commit/b4a4502cdd726103cb8ee423c847e6180f4ba440

Comment 5 michael 2020-07-15 23:45:44 UTC

Git commit 35c6356ae92551666e208dcc87d96ca74b2c5e09 by Michael Reeves.
Committed on 15/07/2020 at 23:43.
Pushed by mreeves into branch 'master'.

Sorry mis-reading  Fix second typo

M  +3    -3    doc/en/man-kdiff3.1.docbook

https://invent.kde.org/sdk/kdiff3/commit/35c6356ae92551666e208dcc87d96ca74b2c5e09

Comment 6 justindonnelly 2020-07-22 20:19:52 UTC

Thanks, but it appears that the commits so far will only fix errors in the OPTIONS portion of the man page.  It does not appear that the commits will fix errors in the SYNOPSIS.

Comment 7 michael 2020-07-24 19:31:05 UTC

Git commit c58ba3c27d27fd49631912abaa9efb7c163c964e by Michael Reeves.
Committed on 24/07/2020 at 19:17.
Pushed by mreeves into branch '1.8'.

Fix SYNOPSIS
FIXED-IN:1.8.4

M  +3    -3    doc/en/man-kdiff3.1.docbook

https://invent.kde.org/sdk/kdiff3/commit/c58ba3c27d27fd49631912abaa9efb7c163c964e

Comment 8 michael 2020-07-24 19:31:06 UTC

Git commit f4781e60f0cbd1d161b0fea3724b00e441d7d93e by Michael Reeves.
Committed on 24/07/2020 at 19:16.
Pushed by mreeves into branch 'master'.

Fix SYNOPSIS
FIXED-IN:1.8.4

M  +3    -3    doc/en/man-kdiff3.1.docbook

https://invent.kde.org/sdk/kdiff3/commit/f4781e60f0cbd1d161b0fea3724b00e441d7d93e