Bug 103216 - 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: Specifications
Classification: Unclassified
Component: desktop-entry (show other bugs)
Version: unspecified
Hardware: Other All
: medium normal
Assignee: Allison Lortie (desrt)
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 103914
  Show dependency treegraph
 
Reported: 2017-10-11 10:27 UTC by Simon McVittie
Modified: 2017-12-24 17:43 UTC (History)
4 users (show)

See Also:
i915 platform:
i915 features:


Attachments
desktop-entry-spec: New section "File naming" (5.02 KB, patch)
2017-10-11 10:28 UTC, Simon McVittie
Details | Splinter Review
desktop-entry-spec: Formalize file naming recommendations (2.33 KB, patch)
2017-10-11 10:28 UTC, Simon McVittie
Details | Splinter Review
desktop-entry-spec: Formalize the reverse DNS convention (1.59 KB, patch)
2017-10-11 10:29 UTC, Simon McVittie
Details | Splinter Review
desktop-entry-spec: Deprecate dashes in well-known names (2.62 KB, patch)
2017-10-11 10:29 UTC, Simon McVittie
Details | Splinter Review

Description Simon McVittie 2017-10-11 10:27:56 UTC
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.

Whichever one is chosen, I'll update the D-Bus Specification to recommend that one and deprecate (un-recommend?) the other.

(To be clear, I am not proposing that the deprecated one ever ceases to work.)

Because of the parallel with D-Bus object paths and interface names, I think we should prefer the underscore. I'll attach some possible patches for that.

For context, when I was working on the Apertis app framework a while ago (which uses subsets of AppStream and .desktop), the rule we applied was to forbid dashes altogether, and require underscores.

Relevant:

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-10-11 10:28:31 UTC
Created attachment 134789 [details] [review]
desktop-entry-spec: New section "File naming"

This combines the notes on file naming that were previously part of
"Basic format of the file" with the former appendix "Desktop File ID".
Comment 2 Simon McVittie 2017-10-11 10:28:45 UTC
Created attachment 134790 [details] [review]
desktop-entry-spec: Formalize file naming recommendations

* Add a link to the canonical definition of a D-Bus well-known name
* Specify punctuation in terms of Unicode code points                 
* Split syntactic rules (character set) and semantic rules
  (relationship to domain names) into separate paragraphs
Comment 3 Simon McVittie 2017-10-11 10:29:02 UTC
Created attachment 134791 [details] [review]
desktop-entry-spec: Formalize the reverse DNS convention

Also mention the D-Bus convention for the part after the domain name,
which is widely deployed and seems as good as anything else.
Comment 4 Simon McVittie 2017-10-11 10:29:24 UTC
Created attachment 134792 [details] [review]
desktop-entry-spec: Deprecate dashes in well-known names

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.                                 
   
Dashes 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.                                                           
                             
An alternative approach would be to allow dashes, deprecate                       
underscores, have a trivial conversion from DNS domain name to
desktop file ID (except in the case of leading digits), and always
special-case the transformation from desktop file ID/well-known bus
name to object path, interface name or Flatpak app ID. However, that
seems more error-prone, because it would make naive code incorrect; 
and general-purpose conversion from DNS domain name to desktop file     
ID is always going to need a special case anyway, to deal with
leading digits (allowed in DNS but not D-Bus).
Comment 6 Alexander Larsson 2017-10-17 10:38:26 UTC
This looks good to me.
Comment 7 David Faure 2017-11-25 21:11:24 UTC
Yes, looks good to me too.

Do you have git access, or should I apply and push the commits?
Comment 8 Simon McVittie 2017-11-26 10:49:30 UTC
(In reply to David Faure from comment #7)
> Do you have git access, or should I apply and push the commits?

I am not a member of the 'standards' group on fdo; if you are, please apply and push.
Comment 9 Simon McVittie 2017-11-26 11:55:28 UTC
(In reply to Simon McVittie from comment #0)
> Whichever one is chosen, I'll update the D-Bus Specification to recommend
> that one and deprecate (un-recommend?) the other.

Bug #103914.
Comment 10 Simon McVittie 2017-12-14 13:36:37 UTC
(In reply to Simon McVittie from comment #8)
> (In reply to David Faure from comment #7)
> > Do you have git access, or should I apply and push the commits?
> 
> I am not a member of the 'standards' group on fdo; if you are, please apply
> and push.

Is there someone who can land this, and preferably refresh the web-accessible Desktop Entry specification document to pick up the change? 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.