Bug 103914 - recommend underscore in reversed domain names, deprecate hyphen/minus
Summary: recommend underscore in reversed domain names, deprecate hyphen/minus
Status: RESOLVED FIXED
Alias: None
Product: dbus
Classification: Unclassified
Component: core (show other bugs)
Version: git master
Hardware: Other All
: medium normal
Assignee: Simon McVittie
QA Contact: D-Bus Maintainers
URL:
Whiteboard: review+
Keywords: patch
Depends on: 103216
Blocks:
  Show dependency treegraph
 
Reported: 2017-11-26 11:52 UTC by Simon McVittie
Modified: 2017-12-24 18:30 UTC (History)
5 users (show)

See Also:
i915 platform:
i915 features:


Attachments
spec: Deprecate hyphen/minus in well-known names (4.59 KB, patch)
2017-11-26 11:54 UTC, Simon McVittie
Details | Splinter Review

Description Simon McVittie 2017-11-26 11:52:08 UTC
+++ This bug was initially created as a clone of Bug #103216 +++

We don't really need two parallel forms of punctuation, and in particular DNS domain names only have one (dashes). If we choose one representation and deprecate the other, it makes the recommendation clearer for app authors.

Relevant:

https://bugs.freedesktop.org/show_bug.cgi?id=103216
https://github.com/flatpak/flatpak-builder/issues/37
https://github.com/parnold-x/nasc/issues/67
https://github.com/elementary/houston/issues/436
Comment 1 Simon McVittie 2017-11-26 11:54:04 UTC
Created attachment 135726 [details] [review]
spec: Deprecate hyphen/minus in well-known names

We don't really need two parallel forms of punctuation, and in
particular DNS domain names only have one (hyphens). If we choose one
representation and deprecate the other, it makes the recommendation
clearer for app authors.

This reflects a similar change to the Desktop Entry Specification,
which uses D-Bus well-known names as app IDs. While hyphens are not a
problem for D-Bus well-known names or for freedesktop.org app IDs,
they create problems for adjacent APIs and specifications that want to
use a well-known name in a context where hyphens are not allowed.
Hyphens are not allowed in D-Bus object paths and interface names,
are only conditionally allowed in Flatpak app IDs (they can only
appear in the last element), and have a special syntactic role in
Freedesktop icon names.

---

Not to be applied until the patches on Bug #103216 are.
Comment 2 Philip Withnall 2017-11-26 21:19:51 UTC
Comment on attachment 135726 [details] [review]
spec: Deprecate hyphen/minus in well-known names

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

Looks good to me. One nitpick, but I don’t care whether it’s changed or not. Good to push with/without a fix.

::: doc/dbus-specification.xml
@@ +1877,5 @@
>            simultaneously if backwards compatibility is required.
>          </para>
>  
> +        <para>
> +          As with interface names, if the author's DNS domain name

Nitpick: ‘As with’ could be a link back to the interface names section.
Comment 3 Alexander Larsson 2017-11-27 08:48:56 UTC
Looks good to me
Comment 4 Simon McVittie 2017-11-27 12:10:03 UTC
(In reply to Philip Withnall from comment #2)
> Nitpick: ‘As with’ could be a link back to the interface names section.

The previous paragraph already has that link, so another one seemed unnecessary.
Comment 5 Philip Withnall 2017-11-27 12:24:17 UTC
(In reply to Simon McVittie from comment #4)
> (In reply to Philip Withnall from comment #2)
> > Nitpick: ‘As with’ could be a link back to the interface names section.
> 
> The previous paragraph already has that link, so another one seemed
> unnecessary.

Ah, cool.
Comment 6 Simon McVittie 2017-12-24 18:30:39 UTC
Fixed in git for spec v0.32 (dbus 1.13.0). 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.