Bug 86162 - [SPEC UPDATE] please document that <annotation> is allowed within <arg> in the XML introspection data
Summary: [SPEC UPDATE] please document that <annotation> is allowed within <arg> in th...
Status: RESOLVED FIXED
Alias: None
Product: dbus
Classification: Unclassified
Component: core (show other bugs)
Version: unspecified
Hardware: Other All
: medium normal
Assignee: D-Bus Maintainers
QA Contact: D-Bus Maintainers
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-11-11 16:06 UTC by Lennart Poettering
Modified: 2016-10-03 10:46 UTC (History)
1 user (show)

See Also:
i915 platform:
i915 features:

Attachments
doc: Add missing space in introspect.xsl (1023 bytes, patch)
2016-10-01 11:49 UTC, Philip Withnall 		Details | Splinter Review
spec: Allow <annotation> in <arg> elements in introspection XML (2.40 KB, patch)
2016-10-01 11:50 UTC, Philip Withnall 		Details | Splinter Review
View All

Description Lennart Poettering 2014-11-11 16:06:54 UTC 
As discussed on the ML: the spec should allow embedding <annotation> within <arg>. Apparently both gdbus and qt make use of this, and it probably makes sense to allow this, hence this should be mentioned in the spec.

Also, the DTD shipped with dbus should really allows this too, since it is the only formalized description of the XML format we have.

See this thread for more info:

http://lists.freedesktop.org/archives/dbus/2014-November/016399.html
Comment 1 Philip Withnall 2016-10-01 11:49:48 UTC 
Created attachment 126932 [details] [review]
doc: Add missing space in introspect.xsl

This adds a space in the output between ‘annotation’ and the key of the annotation. A Saturday afternoon cosmetic fix.
Comment 2 Philip Withnall 2016-10-01 11:50:17 UTC 
Created attachment 126933 [details] [review]
spec: Allow <annotation> in <arg> elements in introspection XML

This is widely used in practice (especially by GLib — just look at files in /usr/share/dbus-1/interfaces/), and there is no reason not to allow it. Update the specification, introspection DTD and XSL file to allow and represent it.
Comment 3 Simon McVittie 2016-10-03 10:03:30 UTC 
Comment on attachment 126932 [details] [review]
doc: Add missing space in introspect.xsl

Review of attachment 126932 [details] [review]:
-----------------------------------------------------------------

XSLT! I'd forgotten we had any of this.

(Looks fine.)
Comment 4 Simon McVittie 2016-10-03 10:04:22 UTC 
Comment on attachment 126933 [details] [review]
spec: Allow <annotation> in <arg> elements in introspection XML

Review of attachment 126933 [details] [review]:
-----------------------------------------------------------------

I assume if any maintainers were going to object to this they would have done so on Lennart's bug report. Let's do this.
Comment 5 Simon McVittie 2016-10-03 10:46:06 UTC 
Fixed in git for 1.11.6, thanks.

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.