Review Request 128192: Remove man pages for scripts that no longer exist

Michael Pyne mpyne at kde.org
Thu Jun 16 02:33:13 UTC 2016



> On June 15, 2016, 11 a.m., Olivier Churlaud wrote:
> > I didn't know what it was so I didn't touch. But I think it's right.
> > 
> > Do you know how I should generate this for the new script?

You can somewhat more easily generate man pages by using Docbook -- except that you can't depend on kdoctools from kapidox. I imagine this is why the man pages for kapidox's tools are pre-generated.

Maybe Python comes with something that would work as well for creating simple man pages?

Generally command-line tools should be documented, but if a man page is not possible then maybe HTML or an alternate format would suffice.


- Michael


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


On June 15, 2016, 10:50 a.m., Michael Palimaka wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/128192/
> -----------------------------------------------------------
> 
> (Updated June 15, 2016, 10:50 a.m.)
> 
> 
> Review request for KDE Frameworks, Alex Merry and Olivier Churlaud.
> 
> 
> Repository: kapidox
> 
> 
> Description
> -------
> 
> kgenapidox and kgenframeworksapidox were removed in bb4063f5d9f9015b86dbc3a48a424c8cb1a8193f.
> 
> 
> Diffs
> -----
> 
>   docs/kgenapidox.1 919d6c68d3f2775a4fdff8551941600be18f9acd 
>   docs/kgenframeworksapidox.1 5a4c638b2974ce905093f48f707db58e56179756 
>   setup.py 607388bb6339a7c1ea81b1ec58690df3fed12252 
> 
> Diff: https://git.reviewboard.kde.org/r/128192/diff/
> 
> 
> Testing
> -------
> 
> Builds and installs correctly to temporary directory.
> 
> 
> Thanks,
> 
> Michael Palimaka
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20160616/23991b94/attachment.html>


More information about the Kde-frameworks-devel mailing list