Bug 23301

Summary:	Uniformize the spec to use Identifier everywhere
Product:	Telepathy	Reporter:	Olivier Le Thanh Duong <olivier>
Component:	tp-spec	Assignee:	Telepathy bugs list <telepathy-bugs>
Status:	RESOLVED FIXED	QA Contact:	Telepathy bugs list <telepathy-bugs>
Severity:	normal
Priority:	medium
Version:	unspecified
Hardware:	Other
OS:	All
Whiteboard:
i915 platform:		i915 features:

Description Olivier Le Thanh Duong 2009-08-14 04:47:18 UTC

For a long time, there was no term to refer to the string corresponding to a handle so the specification was refering to it in several different way and felt a bit inconsistent. Since then the term Identifier has been introduced, but it is still not used everywhere in the Spec.

The following patch correct that.
http://git.collabora.co.uk/?p=user/olethanh/telepathy-spec.git;a=shortlog;h=refs/heads/identifiers

Comment 1 Simon McVittie 2009-08-14 06:42:57 UTC

Looks good, except for a couple of places where I think it's not sufficiently obvious what we're referring to:

> --- a/spec/Channel_Type_Text.xml
> +++ b/spec/Channel_Type_Text.xml
> @@ -419,8 +419,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
>      </tp:property>
>      <tp:property name="name" type="s">
>        <tp:docstring>
> -      A human-visible name for the channel, if it differs from the string
> -      version of the channel's handle.
> +      A human-visible name for the channel, if it differs from the channel's
> +      identifier.

"... from the channel's <tp:dbus-ref namespace="...">TargetID</tp:dbus-ref>", please. (Hyperlinking an appropriate property is more important than using 100% consistent terminology, IMO, and "ID" is just an abbreviation for identifier here anyway.)

> --- a/spec/Connection_Interface_Aliasing.xml
> +++ b/spec/Connection_Interface_Aliasing.xml
> @@ -119,9 +119,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
>        </arg>
>        <tp:docstring>
>          Request the value of several contacts' aliases at once. This SHOULD
> -        only return cached aliases, falling back on the handle name if none > is
> -        present. Also if there was no cached alias, a request SHOULD be started
> -        of which the result is later signalled by
> +        only return cached aliases, falling back on the contact identifier if

"... on the contact identifier (i.e. the string corresponding to the handle)", please.

Comment 2 Olivier Le Thanh Duong 2009-08-16 05:47:51 UTC

I updated the branch to reflect your comments.

Comment 3 Simon McVittie 2009-08-17 09:38:48 UTC

Approved and merged, 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.