After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 767047 - Error in Vapi file cause Valadoc to fail
Error in Vapi file cause Valadoc to fail
Status: RESOLVED FIXED
Product: vala
Classification: Core
Component: Bindings
0.32.x
Other All
: Normal major
: ---
Assigned To: Vala maintainers
Vala maintainers
Depends on:
Blocks:
 
 
Reported: 2016-05-31 00:31 UTC by Chris Daley
Modified: 2016-07-21 13:57 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Diff file to correct Vapi file errror (953 bytes, patch)
2016-05-31 00:31 UTC, Chris Daley
none Details | Review
Updated diff file (946 bytes, patch)
2016-06-16 06:44 UTC, Chris Daley
rejected Details | Review
Correct documentation comment for crypt() (1.26 KB, patch)
2016-06-16 11:38 UTC, Al Thomas
committed Details | Review

Description Chris Daley 2016-05-31 00:31:37 UTC
Created attachment 328770 [details] [review]
Diff file to correct Vapi file errror

The comment block on line 1919 is malformed and causes Valadoc to error. Patch attached.
Comment 1 Al Thomas 2016-05-31 14:08:18 UTC
Review of attachment 328770 [details] [review]:

Thanks for picking up on this, it was my patch that added crypt.

Two points:
 - valadoc seems to take brief description and long description, so should the first line be "A string encoding function." Taken from http://pubs.opengroup.org/onlinepubs/9699919799/functions/crypt.html This should then appear as the tooltip against the function. Untested though as valdoc.org is currently down. Then there should probably be an empty line before the advice about the valac switches
 - git formatted patch?
Comment 2 Chris Daley 2016-06-16 06:44:03 UTC
Created attachment 329891 [details] [review]
Updated diff file

This patch is the full git diff and adds an extra line allowing the top line to be displayed as a Tool Tip by Valadoc.
Comment 3 Al Thomas 2016-06-16 11:38:30 UTC
Created attachment 329899 [details] [review]
Correct documentation comment for crypt()

git formatted patch with "Encodes a string" as short description (tooltip).

To apply without committing:
git apply 0001-posix-Correct-documentation-comment-for-crypt.patch

To apply and commit in one go:
git am 0001-posix-Correct-documentation-comment-for-crypt.patch

Can you check the patch works for you and review as accepted-commit_now ?

The advantage of a git formatted patch is it includes the authors name and a message for the commit log. A git formatted patch can be created after a single local commit with:
git format-patch HEAD^1
Comment 4 Chris Daley 2016-06-16 14:36:44 UTC
(In reply to Al Thomas from comment #3)

That works just fine, thanks for the patch tip.
Comment 5 Al Thomas 2016-06-16 14:55:10 UTC
Review of attachment 329891 [details] [review]:

As per comments above
Comment 6 Al Thomas 2016-06-16 14:55:47 UTC
Review of attachment 329899 [details] [review]:

As per comments above