Bug 452534 - Add manual page
Summary: Add manual page
Status: RESOLVED FIXED
Alias: None
Product: kgeotag
Classification: Applications
Component: General (show other bugs)
Version: 1.2.0
Platform: Debian unstable Linux
: NOR minor
Target Milestone: ---
Assignee: Tobias Leupold
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-04-12 03:21 UTC by count_omega
Modified: 2022-04-14 09:58 UTC (History)
1 user (show)

See Also:
Latest Commit: https://invent.kde.org/graphics/kgeotag/commit/16f3124142de5d612b45e3e13af4b40d7fc88860
Version Fixed In:
Sentry Crash Report:

Attachments
Add an attachment

Note You need to log in before you can comment on or make changes to this bug.
Description count_omega 2022-04-12 03:21:33 UTC 
I maintain KGeotag for Debian. As of now, KGeotag doesn't install a manual file. This causes lintian to throw a warning (see https://lintian.debian.org/tags/no-manual-page). It would be nice if there was a manual to resolve this warning.

Thanks

Matthias
Comment 1 Tobias Leupold 2022-04-12 05:45:48 UTC 
Hi Matthias :-)

Currently, there is no manpage or any kind of documentation that KGeoTag could install (the usage should be quite self-explanatory, isn't it?! ;-) … what kind of manual do you think of? Like simply installing the README.md somewhere so that we install something to silence this warning?
Comment 2 count_omega 2022-04-13 00:09:55 UTC 
Yeah, I guess installing the readme to e.g. /usr/share/man. should work as Kgeotag has no cli options.
Comment 3 count_omega 2022-04-13 00:35:28 UTC 
(In reply to count_omega from comment #2)
> Yeah, I guess installing the readme to e.g. /usr/share/man. should work as
> Kgeotag has no cli options.

It would be also sufficient if you could provide a .help file, I could generate a man page from there.
Comment 4 Tobias Leupold 2022-04-13 06:31:38 UTC 
I'm pretty sure that other distributors (e.g. Gentoo) won't be happy if I install a dummy file to /usr/share/man (manpages are added as compressed files by Gentoo, and a README.md file is not a manpage).

Speaking of a .help file: I never heard this before, but "help help" says "Display information about builtin commands.", and kgeotag is not a builtin command – or is a .help file something else?

Couldn't you simply put the README.md whereever Debian wants it to live whilst packaging KGeoTag to make your infrastructure happy? I'm pretty sure there will never be a manpage for KGeoTag (manpages are for CLI programs, aren't they?!). Maybe some kind of documentation, but not a manpage …

I really don't know what would be the right – and especially meaningful and distribution-agnostic – thing to do right now :-(
Comment 5 Tobias Leupold 2022-04-13 06:37:24 UTC 
Maybe, we could take the description of KGeoTag from https://kgeotag.kde.org/ and put it in some .docbook file, like the other KDE programs do? That would definitely be better documentation than the README.md file!
Comment 6 count_omega 2022-04-13 16:06:03 UTC 
Yeah, a docboook file wouldbe a good idea.
Comment 7 Tobias Leupold 2022-04-13 16:15:34 UTC 
Okay. I'll see how I can create one. I never used this before ;-)
Comment 8 count_omega 2022-04-13 16:16:39 UTC 
OK, thanks. I'll close this bug then.
Comment 9 Tobias Leupold 2022-04-13 16:27:45 UTC 
Maybe leave it open as a reminder. I can close it when I push the docbook file.
Comment 10 Tobias Leupold 2022-04-14 09:58:19 UTC 
Git commit 16f3124142de5d612b45e3e13af4b40d7fc88860 by Tobias Leupold.
Committed on 14/04/2022 at 09:57.
Pushed by tleupold into branch 'master'.

Added a handbook stub

M  +11   -1    CMakeLists.txt
M  +2    -0    ChangeLog.rst
M  +1    -1    ChangeLog.rst.license
A  +60   -0    doc/index.docbook
A  +156  -0    doc/overview.docbook

https://invent.kde.org/graphics/kgeotag/commit/16f3124142de5d612b45e3e13af4b40d7fc88860