Bug 288463 - hyphen-used-as-minus-sign cleanup_digikamdb.1 digitaglinktree.1 [patch]
Summary: hyphen-used-as-minus-sign cleanup_digikamdb.1 digitaglinktree.1 [patch]
Status: REPORTED
Alias: None
Product: digikam
Classification: Applications
Component: Documentation (show other bugs)
Version: 2.3.0
Platform: Debian unstable Linux
: NOR normal
Target Milestone: ---
Assignee: Digikam Developers
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-12-08 10:07 UTC by Mark Purcell
Modified: 2022-01-10 16:12 UTC (History)
3 users (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments
escaped "-" as required by groff (2.53 KB, patch)
2013-04-09 13:53 UTC, saurabh
Details
escaped "-" as required by groff in digitaglinktree.1 (9.28 KB, patch)
2013-04-09 13:55 UTC, saurabh
Details
proper diff file for patch (10.42 KB, patch)
2013-04-10 20:06 UTC, saurabh
Details
updated patch (9.53 KB, patch)
2013-04-15 12:15 UTC, saurabh
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Mark Purcell 2011-12-08 10:07:30 UTC
Version:           2.3.0 (using KDE 4.7.3) 
OS:                Linux

These manual page seems to contain a hyphen where a minus sign was intended. By default, "-" chars are interpreted as hyphens (U+2010) by groff, not as minus signs (U+002D). Since options to programs use minus signs (U+002D), this means for example in UTF-8 locales that you cannot cut and paste options, nor search for them easily.

"-" must be escaped ("\-") to be interpreted as minus. If you really intend a hyphen (normally you don't), write it as "\(hy" to emphasise that fact.

If you use some tool that converts your documentation to groff format, this tag may indicate a bug in the tool. Some tools convert dashes of any kind to hyphens. The safe way of converting dashes is to convert them to "\-".

Severity: wishlist, Certainty: possible

Reproducible: Always

Steps to Reproduce:
source code inspection

Actual Results:  
hyphen-used-as-minus-sign
usr/share/man/man1/cleanup_digikamdb.1.gz:18
usr/share/man/man1/digitaglinktree.1.gz 14 more occurrences not shown
usr/share/man/man1/digitaglinktree.1.gz:30
usr/share/man/man1/digitaglinktree.1.gz:33
usr/share/man/man1/digitaglinktree.1.gz:46
usr/share/man/man1/digitaglinktree.1.gz:52
usr/share/man/man1/digitaglinktree.1.gz:75
usr/share/man/man1/digitaglinktree.1.gz:76
usr/share/man/man1/digitaglinktree.1.gz:81
usr/share/man/man1/digitaglinktree.1.gz:83
usr/share/man/man1/digitaglinktree.1.gz:88
usr/share/man/man1/digitaglinktree.1.gz:97

Expected Results:  
"-" must be escaped ("\-") to be interpreted as minus

OS: Linux (x86_64) release 3.1.0-1-amd64
Compiler: gcc
Comment 1 caulier.gilles 2011-12-08 10:12:38 UTC
Patch will be appreciate...

Gilles Caulier
Comment 2 saurabh 2013-04-08 12:36:55 UTC
Gilles,
   I am interested in working on this bug.I wanted to ask whether "-" is to be escaped as "\-" only in the 2 files digikaminktree1 and cleanup_digikamdb.1.Also is there any command which shows occurence of all such "-" symbols so that none of the symbol is left in escaping as Mark has shown in his comment which shows occurences of "-"
Comment 3 caulier.gilles 2013-04-09 07:54:32 UTC
Saurabh,

I don't know about man page syntax.  Try to google the problem.
Comment 4 saurabh 2013-04-09 13:47:39 UTC
Gilles and Mark,
I am adding attachment of the files after correcting the required files.
So,please review it Mark since Gilles didn't have much idea about manpage syntax
It's sort of patch for the bug but I couldn't make a diff file since it is not in my build directory

Thanks
Comment 5 saurabh 2013-04-09 13:53:32 UTC
Created attachment 78750 [details]
escaped "-" as required by groff
Comment 6 saurabh 2013-04-09 13:55:34 UTC
Created attachment 78751 [details]
escaped "-" as required by groff in digitaglinktree.1
Comment 7 saurabh 2013-04-10 20:06:37 UTC
Created attachment 78781 [details]
proper diff file for patch
Comment 8 Smit Mehta 2013-04-12 17:40:42 UTC
Hi saurabh

The patch is giving HUNK errors while applying. Can you please update your patch for the current git repo?

Smit
Comment 9 saurabh 2013-04-13 09:30:01 UTC
Hi Smit,
   Can you give me information about the errors which you are getting while applying so that I could update my patch accordingly

Saurabh
Comment 10 Smit Mehta 2013-04-13 14:04:26 UTC
patching file utilities/scripts/cleanup_digikamdb/cleanup_digikamdb.1
patching file utilities/scripts/digitaglinktree/digitaglinktree.1
Hunk #4 FAILED at 72.
Hunk #8 FAILED at 173.
2 out of 8 hunks FAILED -- saving rejects to file utilities/scripts/digitaglinktree/digitaglinktree.1.rej
patching file utilities/kipiiface/kipiinterface.cpp
Hunk #1 FAILED at 173.
1 out of 1 hunk FAILED -- saving rejects to file utilities/kipiiface/kipiinterface.cpp.rej
Comment 11 saurabh 2013-04-15 12:15:40 UTC
Created attachment 78926 [details]
updated patch
Comment 12 Smit Mehta 2013-04-15 13:07:26 UTC
Still not working.

patching file utilities/scripts/cleanup_digikamdb/cleanup_digikamdb.1
patching file utilities/scripts/digitaglinktree/digitaglinktree.1
Hunk #4 FAILED at 72.
patch: **** malformed patch at line 181:  

Kindly test it against the latest git and then post it. For testing it,
(a) Create the patch and save it somewhere
(b) Checkout all the changes in the local repo, update your repo
(c) Reapply the patch and see if it works.

Smit