Review Request 115063: Created missing manpage for desktoptojson binary

[Sebastian Kügler]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/115063/#review47561
-----------------------------------------------------------


Hi Scarlett,

Congrats to your first patch (that I see coming by)! I think it's a useful contribution and as far as I can judge, almost good to go in. I've put a comment inline how the explanation could be further improved.

I don't know much about manpages, so I'll let someone else comment on the mechanics.

Thanks for taking care of this.


docs/desktoptojson/man-desktoptojson.8.docbook
<https://git.reviewboard.kde.org/r/115063/#comment33781>

    A link to the API docs for KPluginTrader would be useful. There, the user (developer, really, this is a development tool) finds more extensive documentation about its usage. As API documentation location hasn't really settled down yet, adding a sentence like this would probably be enough already:
    
    "For further reference how to use this programme and its underlying mechanism, please refer to the documentation for the KPluginTrader class in KDE's KService framework."


- Sebastian Kügler


On Jan. 17, 2014, 2:52 a.m., Scarlett Clark wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/115063/
> -----------------------------------------------------------
> 
> (Updated Jan. 17, 2014, 2:52 a.m.)
> 
> 
> Review request for Documentation, KDE Frameworks, Jonathan Riddell, and Sebastian Kügler.
> 
> 
> Repository: kservice
> 
> 
> Description
> -------
> 
> While building the package for kubuntu lintian complained about missing manpage for binary. So I created one :) This is my first manpage so be kind. I have no idea how to determine what type eg 1, 7, 8.
> 
> 
> Diffs
> -----
> 
>   docs/CMakeLists.txt 86ed60b 
>   docs/desktoptojson/CMakeLists.txt PRE-CREATION 
>   docs/desktoptojson/man-desktoptojson.8.docbook PRE-CREATION 
> 
> Diff: https://git.reviewboard.kde.org/r/115063/diff/
> 
> 
> Testing
> -------
> 
>  meinproc5 --stylesheet /usr/share/ksgmltools2/customization/kde-include-man.xsl --check man-desktoptojson.8.docbook 
> 
> 
> Thanks,
> 
> Scarlett Clark
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20140117/1bc29268/attachment.html>