Bug 28613

Summary:	Rearrange and polish Messages interface
Product:	Telepathy	Reporter:	Will Thompson <will>
Component:	tp-spec	Assignee:	Will Thompson <will>
Status:	RESOLVED FIXED	QA Contact:	Telepathy bugs list <telepathy-bugs>
Severity:	normal
Priority:	medium	CC:	olivier
Version:	git master	Keywords:	patch
Hardware:	Other
OS:	All
URL:	http://git.collabora.co.uk/?p=user/wjt/telepathy-spec-wjt.git;a=shortlog;h=refs/heads/messages-lint
Whiteboard:	review+
i915 platform:		i915 features:

Description Will Thompson 2010-06-19 05:16:09 UTC

The Messages interface is incredibly long. In particular, the Message_Part definition <http://telepathy.freedesktop.org/spec/Channel_Interface_Messages.html#Message_Part> is massive and hard to follow, with header and body key definitions (and then some more headers for delivery) interspersed with short paragraphs and long rationales and examples.

So before I add any more to this interface, here's a branch which tidies it up. I split out the definitions of well-known message part keys into three simple-types, added a load of cross-referencing markup, and rephrased a bunch of the documentation. I think it's easier to follow now.

http://people.freedesktop.org/~wjt/telepathy-spec-messages_lint/spec/Channel_Interface_Messages.html

Comment 1 Simon McVittie 2010-06-22 08:37:30 UTC

I endorse this initiative. r+

Comment 2 Will Thompson 2010-06-22 08:45:32 UTC

Ta, merged to master.

CCing Olivier, who was interested in taking a look from the POV of someone who recently implemented the messages interface.

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.