Unity 8

Merge lp:~mzanetti/unity8/install-devices-conf-default into lp:unity8

install-devices-conf-default
Merge into trunk

Proposed by Michael Zanetti on 2016-03-30

Status:	Merged
Approved by:	Michael Terry on 2016-04-12
Approved revision:	2319
Merged at revision:	2363
Proposed branch:	lp:~mzanetti/unity8/install-devices-conf-default
Merge into:	lp:unity8
Diff against target:	110 lines (+55/-0) 5 files modified data/devices.conf (+30/-0) debian/unity8.install (+1/-0) doc/devices.conf (+15/-0) plugins/Utils/deviceconfigparser.cpp (+8/-0) plugins/Utils/deviceconfigparser.h (+1/-0)
To merge this branch:	bzr merge lp:~mzanetti/unity8/install-devices-conf-default
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
Unity8 CI Bot	continuous-integration		Needs Fixing on 2016-04-12
Michael Terry		2016-03-31	Approve on 2016-04-12
Michael Zanetti			Pending
Review via email: mp+290478@code.launchpad.net

Commit Message

install devices.conf by default

Description of the Change

* Are there any related MPs required for this MP to build/function as expected? Please list.
n
* Did you perform an exploratory manual test run of your code change and any related functionality?
y
* Did you make sure that your branch does not contain spurious tags?
y
* If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
y
* If you changed the UI, has there been a design review?
n/a

lp:~mzanetti/unity8/install-devices-conf-default updated on 2016-03-30

2314. By Michael Zanetti on 2016-03-30: install devices.conf by default

Unity8 CI Bot (unity8-ci-bot) wrote on 2016-03-30:

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-unity8-ci/892/rebuild

review: Needs Fixing (continuous-integration)

lp:~mzanetti/unity8/install-devices-conf-default updated on 2016-03-31

2315. By Michael Zanetti on 2016-03-31: use a separate config for the default install, extend the docs one a bit
2316. By Michael Zanetti on 2016-03-31: drop unneded line in example
2317. By Michael Zanetti on 2016-03-31: search in /system/etc/ubuntu too, in case there is a device tarball override

Unity8 CI Bot (unity8-ci-bot) wrote on 2016-03-31:

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-unity8-ci/901/rebuild

review: Needs Fixing (continuous-integration)

Unity8 CI Bot (unity8-ci-bot) wrote on 2016-03-31:

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-unity8-ci/902/rebuild

review: Needs Fixing (continuous-integration)

Michael Terry (mterry) wrote on 2016-04-12:

I'd feel better if the example in the shipped devices.conf was commented out. No reason to ship a live example.

And maybe a comment in deviceconfigparser.cpp that any new properties or changed defaults should be updated in both doc/devices.conf and data/devices.conf? These could easily get out of sync.

review: Needs Fixing

lp:~mzanetti/unity8/install-devices-conf-default updated on 2016-04-12

2318. By Michael Zanetti on 2016-04-12: add a comment

Michael Zanetti (mzanetti) wrote on 2016-04-12:

> I'd feel better if the example in the shipped devices.conf was commented out.
> No reason to ship a live example.
>
> And maybe a comment in deviceconfigparser.cpp that any new properties or
> changed defaults should be updated in both doc/devices.conf and
> data/devices.conf? These could easily get out of sync.

I've added a comment to keep things in sync.

We need to preinstall something in /etc/ because otherwise it can't be overridden by the device tarball. That's basically the only reason for this branch at all. We landed the support for device config files in /etc and only learned afterwards that the device tarball can't inject new files but only override existing ones.

Michael Terry (mterry) wrote on 2016-04-12:

Oh, I'm +1 for shipping the file. I'm just saying, comment out the example it contains. Not that we're likely to have a device called "devicename", but seems cleaner not to tempt fate.

lp:~mzanetti/unity8/install-devices-conf-default updated on 2016-04-12

2319. By Michael Zanetti on 2016-04-12: comment out the example

Michael Terry (mterry) wrote on 2016-04-12:

Awesome. Looks good, no bad tags. I +1 the trivial debian/ changes.

review: Approve

Unity8 CI Bot (unity8-ci-bot) wrote on 2016-04-12:

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-unity8-ci/984/rebuild

review: Needs Fixing (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Michael Zanetti

Mohammad Rakibul Hasan

Unity Team

 === added file 'data/devices.conf'
 --- data/devices.conf	1970-01-01 00:00:00 +0000
 +++ data/devices.conf	2016-04-12 21:51:01 +0000
@@ -0,0 +1,30 @@
++# This file can hold multiple device configs. Devices are separated by sections.
++#
++# SupportedOrientations holds a list of all enabled orientations. A standard
++# phone will usually have Portrait,Landcape,InvertedLandscape in order to
++# disable upside down usage.
++#
++# PrimaryOrientation gives the orientation the device will start up with
++# when there is no orientations sensor input available (yet) or lock to
++# when an application specifies to be locked to PrimaryOrientation.
++#
++# The other Orientation settings can be used to re-map the orientations.
++# A device might be used with different orientations than how the screen
++# is physically mounted on the hardware.
++#
++# Category can be phone, tablet, or desktop. This option determines
++# whether the side stage is shown (tablet) or not (phone). Using
++# desktop will load the shell in windowed mode. Note that the user
++# can override/change this by connecting input hardware or change
++# user settings.
++#
++# Any options not listed will default to the values of the example below.
++
++# [devicename]
++# SupportedOrientations=Portrait,InvertedPortrait,Landscape,InvertedLandscape
++# PrimaryOrientation=PrimaryOrienation
++# PortraitOrientation=Portrait
++# InvertedPortraitOrientation=InvertedPortrait
++# LandscapeOrientation=Landscape
++# InvertedLandscapeOrientation=InvertedLandscape
++# Category=phone
 === modified file 'debian/unity8.install'
 --- debian/unity8.install	2015-11-20 13:04:46 +0000
 +++ debian/unity8.install	2016-04-12 21:51:01 +0000
@@ -2,6 +2,7 @@
  data/unity8-dash.conf usr/share/upstart/sessions/
  data/unity8-filewatcher.conf usr/share/upstart/sessions/
  data/unity8.conf usr/share/upstart/sessions/
++data/devices.conf etc/ubuntu/
  usr/bin/unity8
  usr/bin/unity8-dash
  usr/share/applications/unity8-dash.desktop
 === modified file 'doc/devices.conf'
 --- doc/devices.conf	2016-02-18 09:12:13 +0000
 +++ doc/devices.conf	2016-04-12 21:51:01 +0000
@@ -28,3 +28,18 @@
  LandscapeOrientation=Landscape
  InvertedLandscapeOrientation=InvertedLandscape
  Category=phone
++
++# Example for the Nexus 7
++# This device has the screen mounted in portrait, but we run it as a landscape
++# device and we want the side stage on it.
++[flo]
++PrimaryOrientation=LandscapeOrienation
++Category=tablet
++
++# Example for the Nexus 4
++# The screen is already mounted the way we want it, so no special config
++# required. However, we don't want the phone to rotate upside down, so lets
++# restrict that.
++[mako]
++SupportedOrientations=Portrait,Landscape,InvertedLandscape
++Category=phone
 === modified file 'plugins/Utils/deviceconfigparser.cpp'
 --- plugins/Utils/deviceconfigparser.cpp	2016-02-18 16:53:54 +0000
 +++ plugins/Utils/deviceconfigparser.cpp	2016-04-12 21:51:01 +0000
@@ -23,6 +23,7 @@
  DeviceConfigParser::DeviceConfigParser(QObject *parent): QObject(parent)
+ {
++    // Local files have highest priority
      QString path;
      Q_FOREACH (const QString &standardPath, QStandardPaths::standardLocations(QStandardPaths::GenericConfigLocation)) {
          if (QFileInfo(standardPath + "/devices.conf").exists()) {
@@ -31,9 +32,16 @@
+         }
+     }
++    // Check if there is an override in the device tarball (/system/etc/)
++    if (path.isEmpty() && QFileInfo::exists("/system/etc/ubuntu/devices.conf")) {
++        path = "/system/etc/ubuntu/devices.conf";
++    }
++
++    // No higher priority files found. Use standard of /etc/
      if (path.isEmpty()) {
          path = "/etc/ubuntu/devices.conf";
+     }
++
      qDebug() << "Using" << path << "as device configuration file";
      m_config = new QSettings(path, QSettings::IniFormat, this);
+ }
 === modified file 'plugins/Utils/deviceconfigparser.h'
 --- plugins/Utils/deviceconfigparser.h	2016-02-16 17:20:02 +0000
 +++ plugins/Utils/deviceconfigparser.h	2016-04-12 21:51:01 +0000
@@ -25,6 +25,7 @@
      Q_OBJECT
      Q_PROPERTY(QString name READ name WRITE setName NOTIFY changed)
++    // NOTE: When changing this properties, also update the examples in docs and data
      Q_PROPERTY(Qt::ScreenOrientation primaryOrientation READ primaryOrientation NOTIFY changed)
      Q_PROPERTY(Qt::ScreenOrientations supportedOrientations READ supportedOrientations NOTIFY changed)
      Q_PROPERTY(Qt::ScreenOrientation landscapeOrientation READ landscapeOrientation NOTIFY changed)