[kde-doc-english] Review Request 128123: kaffeine: use cmake to update the docbook version

Burkhard Lück lueck at hube-lueck.de
Wed Jun 8 04:07:38 UTC 2016


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



-1 for several reasons:

if you change the version number because of code changes, this does not 
automatically mean the docbook has been updated as well.
the template.docbook in kdoctools has:

<title>The &kmyapplication; Handbook</title> -> no version in title

A comment when to change date/releaseinfo
Change date/releasinfo if
   docbook is updated and verified to be valid for the current app version
   docbook is proofreaded and verified to be valid for the current app version

all project docbooks, but not the code where @KAFFEINE_VERSION@ is defined are pulled 
locally into l10n-kf5/documentation, so we can use tools like grep or scripts
to e.g find docbooks older than x years or x releases, or search for translated 
language docbooks with date + releaseinfo != english docbooks
this does not work with a CMake variable, but requires literal strings 
for date and releaseinfo

Please discard this review, I have already changed the title locally in my
updated handbook

- Burkhard Lück


On Juni 8, 2016, 12:33 vorm., Mauro Carvalho Chehab wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/128123/
> -----------------------------------------------------------
> 
> (Updated Juni 8, 2016, 12:33 vorm.)
> 
> 
> Review request for Documentation, Kaffeine and Burkhard Lück.
> 
> 
> Repository: kaffeine
> 
> 
> Description
> -------
> 
> Use cmake to update the docbook version
> 
> 
> Diffs
> -----
> 
>   doc/CMakeLists.txt 06f05fb82675 
>   doc/index.docbook 3f069a7f857b 
> 
> Diff: https://git.reviewboard.kde.org/r/128123/diff/
> 
> 
> Testing
> -------
> 
> IMHO, instead of hardcoding the Kaffeine version at the documentation, we could use cmake to auto-generate with the enclosed patch.
> 
> 
> Thanks,
> 
> Mauro Carvalho Chehab
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-doc-english/attachments/20160608/09fa5a20/attachment.html>


More information about the kde-doc-english mailing list