diff options
author | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2012-01-31 15:51:51 +0000 |
---|---|---|
committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2012-01-31 16:03:05 +0000 |
commit | b107e7b4c1abacae5e1b460f71514ad8171f8cc4 (patch) | |
tree | e40e04636e514485fc059a12986d9439c7a0c436 | |
parent | 211e913e0fa78349b230ada3044deea9226a58f4 (diff) |
Use underscores, not hyphen/minus signs, in protocol/service names
-rw-r--r-- | spec/Account.xml | 10 | ||||
-rw-r--r-- | spec/Connection_Manager.xml | 21 | ||||
-rw-r--r-- | spec/Protocol.xml | 23 |
3 files changed, 32 insertions, 22 deletions
diff --git a/spec/Account.xml b/spec/Account.xml index 0e53c046..fa9f4777 100644 --- a/spec/Account.xml +++ b/spec/Account.xml @@ -256,24 +256,24 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. user-recognised brands, such as <i>Google Talk</i> and <i>Ovi by Nokia</i>. On accounts for such services, this property SHOULD be set to a string describing the service, which MUST consist only of - ASCII letters, numbers and hyphen/minus signs, and start with a + ASCII letters, numbers and underscores, and start with a letter (matching the requirements for <tp:type>Protocol_Name</tp:type>). For the <tt>jabber</tt> protocol, one of the following service names should be used if possible:</p> <ul> - <li><tt>google-talk</tt> (for <a + <li><tt>google_talk</tt> (for <a href="http://www.google.com/talk/">Google's IM service</a>)</li> - <li><tt>ovi-chat</tt> (for <a href="http://www.ovi.com/">Ovi</a>'s IM + <li><tt>ovi_chat</tt> (for <a href="http://www.ovi.com/">Ovi</a>'s IM service)</li> <li><tt>facebook</tt> (for <a href="http://www.facebook.com/sitetour/chat.php">Facebook's IM service</a>)</li> - <li><tt>lj-talk</tt> (for <a + <li><tt>lj_talk</tt> (for <a href="http://www.livejournal.com/chat/">LiveJournal's IM service</a>)</li> - <li><tt>windows-live</tt> (for <a + <li><tt>windows_live</tt> (for <a href="http://live.com">Windows Live Messenger IM service</a>)</li> </ul> diff --git a/spec/Connection_Manager.xml b/spec/Connection_Manager.xml index caab7510..2b8f5240 100644 --- a/spec/Connection_Manager.xml +++ b/spec/Connection_Manager.xml @@ -59,8 +59,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <tp:simple-type name="Protocol_Name" type="s" array-name="Protocol_Name_List"> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>An instant messaging protocol. It must consist only of ASCII - letters, digits and hyphen/minus signs (U+002D "-"), and must start - with a letter. Where possible, this SHOULD be + letters, digits and underscores, and must start + with a letter or underscore. Where possible, this SHOULD be chosen from the following well-known values:</p> <ul> @@ -70,7 +70,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <li>icq - ICQ (OSCAR)</li> <li>irc - Internet Relay Chat (RFC 1459, 2810-2813)</li> <li>jabber - XMPP (RFC 3920, 3921) or Jabber</li> - <li>local-xmpp - Link-local XMPP (XEP-0174) (Bonjour, Salut)</li> + <li>local_xmpp - Link-local XMPP (XEP-0174) (Bonjour, Salut)</li> <li>msn - MSNP (Windows Live Messenger)</li> <li>myspace - MySpaceIM</li> <li>mxit - MXit</li> @@ -89,9 +89,24 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <li>yahoojp - Japanese version of YMSG</li> <li>zephyr - Zephyr</li> </ul> + + <tp:rationale> + <p>Identifiers formed with letters, digits and underscores and not + starting with a digit are valid in all syntactically-restricted + strings used in D-Bus, and non-problematic in filenames.</p> + + <p>Telepathy 0.x used hyphen/minus instead of underscore in the + canonical form of a protocol name, which meant that protocol + names often had to be transformed between their canonical form, + and a form that used underscores for use in a D-Bus name.</p> + </tp:rationale> </tp:docstring> <tp:changed version="0.17.1">Prior to version 0.17.1, the allowed characters were not specified</tp:changed> + <tp:changed version="UNRELEASED"> + In Telepathy 0.x, protocol names could contain hyphen/minus signs, + but not underscores. + </tp:changed> </tp:simple-type> <tp:struct name="Param_Spec" array-name="Param_Spec_List"> diff --git a/spec/Protocol.xml b/spec/Protocol.xml index 52545d85..7197b81d 100644 --- a/spec/Protocol.xml +++ b/spec/Protocol.xml @@ -31,20 +31,15 @@ <p>Each Protocol object has the same well-known bus name as its parent ConnectionManager. Its object path is formed by taking the - ConnectionManager's object path and appending '/', followed by the - <tp:type>Protocol_Name</tp:type> with any hyphen/minus '-' - converted to underscores '_'.</p> - - <tp:rationale> - <p>This is the same as the representation of protocol names - in Account object paths, and in Connection object paths and bus - names. For instance, telepathy-gabble and telepathy-salut would - implement objects at - <code>/im/telepathy1/ConnectionManager/gabble/jabber</code> - and - <code>/im/telepathy1/ConnectionManager/salut/local_xmpp</code>, - respectively.</p> - </tp:rationale> + ConnectionManager's object path and appending '/' followed by the + <tp:type>Protocol_Name</tp:type>.</p> + + <p>For instance, telepathy-gabble and telepathy-salut would + implement objects at + <code>/im/telepathy1/ConnectionManager/gabble/jabber</code> + and + <code>/im/telepathy1/ConnectionManager/salut/local_xmpp</code>, + respectively.</p> <p>If the ConnectionManager has a <tt>.manager</tt> file, each Protocol's immutable properties must be represented in that file; |