Adding build info attribute to KAboutData to improve bug report data?

[Kevin Funk]

On Sunday, 8 October 2017 19:45:00 CEST Kevin Funk wrote:
> Heya,
> 
> The KDevelop team is currently discussing a patch which adds git-describe
> like information to the version string in KAboutData:
>   https://phabricator.kde.org/D8158
>   (don't bother reading through the comments...)
> 
> Problem:
> 
> When KAboutData's version is set to something like "5.1.80-24-g262fb4cb9f"
> and when attempting to report a bug via KDevelop -> Help -> Report Bug,
> bugs.kde.org will no longer pre-select the correct version in the version
> list. Even worse: The version information is lost completely if the user
> does not copy it from the dialog.
> 
> Idea:
> Let's add a 'build info' attribute to KAboutData which may contain custom
> data filled by a project to provide more information about a specific
> build.
> 
> Then, for instance in KDevelop's main.cpp:
> ```
> KAboutData data(...);
> data.setBuildInfo("Version: " KDEVELOP_FULL_VERSION_STRING);
> ```
> ... with KDEVELOP_FULL_VERSION_STRING being "5.1.80-24-g262fb4cb9f"

@KCoreAddons maintainers: Do you think that makes sense? In that case I'd 
create a patch which adds such API to KAboutData.

Regards,
Kevin

> And then during the bug report process, just amend the url used to direct
> the user to bugs.kde.org:
>   https://bugs.kde.org/enter_bug.cgi?
> format=guided&product=kdevelop&version=5.1.80&comment=Build%20information:
> %0AVersion:%205.1.80-24-g262fb4cb9f
> 
> Would require changes in kcoreaddons (KAboutData) and kxmlgui (KBugReport)
> afaics.
> 
> Comments? There are a couple of other KDE projects (thinking of krita, kexi
> -- which also use Git info) which could benefit from this.
> 
> This is also extensible, one could add more content to the build info
> attribute which would be sent over to bugs.kde.org.
> 
> Regards,
> Kevin


-- 
Kevin Funk | kfunk at kde.org | http://kfunk.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 163 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20171015/f8bc9564/attachment.sig>