ubuntu-touch-coreapps-reviewers team mailing list archive

[MatthewAllen <whosdaz@xxxxxxxxx>]

MatthewAllen has proposed merging lp:~whosdaz/ubuntu-filemanager-app/gci6198315054006272 into lp:ubuntu-filemanager-app.

Requested reviews:
  Ubuntu File Manager Developers (ubuntu-filemanager-dev)

For more details, see:
https://code.launchpad.net/~whosdaz/ubuntu-filemanager-app/gci6198315054006272/+merge/281280
-- 
Your team Ubuntu File Manager Developers is requested to review the proposed merge of lp:~whosdaz/ubuntu-filemanager-app/gci6198315054006272 into lp:ubuntu-filemanager-app.

=== modified file 'README'
--- README	2014-11-11 19:20:57 +0000
+++ README	2015-12-23 10:02:03 +0000
@@ -1,169 +1,14 @@
-# Ubuntu File Manager
-
-File manager app for Ubuntu on the desktop and on mobile devices.
-
-## Building the app
-
-### For the desktop
-
-Install the following build dependencies:
-
-    sudo apt-get install libtag1-dev libpam0g-dev python3
-
-Then open the CMakeLists.txt file in Qt Creator, and ensure that the kit
-selected on the left sidebar (just above the green "Run" button) is "Desktop"
-
-### For a device
-
-If you don't have one already, you'll need to create an armhf chroot to
-cross-compile the app (also do this if you have an older armhf chroot, for
-example 14.04 and current target is 14.10. You can first delete the old target
-and then create a current one). Here's how:
-
-1. In Qt Creator, open the CMakeLists.txt file
-2. Go to Tools > Options > Ubuntu > Click
-2. Click on Create Click Target
-3. Follow the prompts to generate the chroot. You will be asked for your sudo
-   password
-4. Once created, you'll need to add the build dependencies for the app:
-  - Click on the Maintain button on your chroot
-  - On the terminal prompt that is started, type
-    apt-get install libtag1-dev:armhf libpam0g-dev:armhf python3
-  - Close the terminal when the installation finishes
-5. Now you can either do a clean checkout and wait to be prompted by Qt Creator
-   to add the armhf kit, or alternatively:
-6. Go to the Projects tab > Add kit and then select the UbuntuSDK armhf kit
-
-Additionally, you'll have to tell Qt Creator that you are doing a build for a
-device to ultimately create a click package for installation:
-
-1. In Qt Creator, go to the Projects tab on the sidebar
-2. Click on the "Build" subtab of the "UbuntuSDK for armhf..." tab
-3. Then go to the "CMake arguments" text field and add "-DCLICK_MODE=on"
-   without the quotes
-
-Before starting the build make sure to select the "UbuntuSDK" kit on Qt
-Creator's left sidebar (just above the green "Run" button).
-
-### Doing the build
-
-Ensure you've selected the kit you want for your build and press the build
-button on Qt Creator's left sidebar (or alternatively Ctrl+B).
-
-## Running the app
-
-### On the desktop
-
-No additional steps are required before running the app on the desktop.
-
-You can pass two switches to run in phone or tablet mode from the desktop:
-
--p for phone mode
--t for tablet mode
-
-
-### On a device
-
-Due to Qt Creator's bug #1312094 in launchpad.net, there needs to be a manual
-workaround done before the app can run on the device:
-
-1. Modify the desktop.in file: change the Exec line to read:
-   Exec=lib/arm-linux-gnueabihf/bin/@EXEC@
-
-Remember to revert this temporary change if you are building a click package or
-if you're making other changes to be committed to the code!
-
-### Starting the app
-
-Ensure you've selected the kit you want for your build and press the run
-button on Qt Creator's left sidebar (or alternatively Ctrl+R).
-
-If the app hasn't been built yet, or if there are pending changes that require
-a build, the app will automatically be built first before running.
-
-If you're starting the app on a device, the build will be copied over and the
-code will run unconfined.
-
-## Building a click package
-
-There are two alternative ways of building a click package.
-
-### Using Qt Creator
-
-1. Ensure you've selected the UbuntuSDK for armhf kit on Qt Creator's sidebar
-2. Click on Publish on the sidebar
-3. Click on "Create package"
-4. If all goes well, you'll find the final click package in the build directory
-
-Notes:
-- You can see the output of the click build if you click on Edit on the sidebar
-  and then "Application Output" at the bottom. This is useful to identify any
-  failures during the build
-- Run `sudo apt-get install click-reviewers-tools` to enable click package
-  validation in Qt Creator. You might need to restart Qt Creator after you've
-  installed them for it to detect them
-
-### Using click-buddy
-
-1. Install phablet-tools: `sudo apt-get install phablet-tools`
-2. Run click-buddy in your source tree:
-   click-buddy --dir . --arch armhf --framework ubuntu-sdk-14.04
-3. Once finished, click-buddy will tell you the location of your source package
-
-## Installing a click package
-
-First of all, ensure you've got a working Ubuntu device attached over USB to
-your host computer
-
-### Manually
-
-Run the following commands to manually install the click package (replace 0.5
-with the version of your package):
-
-    adb push com.ubuntu.filemanager_0.3.latest_armhf.click /home/phablet/
-    adb shell
-    sudo -H -u phablet pkcon install-local /home/phablet/com.ubuntu.filemanager_0.3_armhf.click
-
-### Using click-buddy
-
-You can add the --provision argument to the previous command to install the
-click package on the device.
-
-### Starting the app
-
-1. Either kill unity8 with `pkill unity8` or restart the system for the Apps
-   (click) scope to pick up your newly installed click package
-2. Search for Reminders in the Apps scope and tap on its icon to start it
-3. You'll find the runtime logs at ~/.cache/upstart/application-click/
-
-## Uninstalling a click package
-
-Run the following commands, replacing the version of the click package you want
-to uninstall:
-
-    adb shell
-    sudo -iu phablet
-    sudo click unregister com.ubuntu.filemanager 0.3
-
-## Run the autopilot tests
-
-Prerequisites:
-    sudo apt-get install ubuntu-ui-toolkit-autopilot
-
-Once the app has been built, you can go to the build directory and run:
-
-    cd tests/autopilot
-    autopilot3 run filemanager
-
-You can run filemanager in phone or tablet mode passing one of these two switches:
-
--p for phone mode
--t for tablet mode
-
-so:
-
-autopilot3 launch ../../src/app/filemanager -p
-
-will launch filemanager with autopilot in phone mode.
-
-
+ReadMe - Ubuntu Filemanager
+===========================
+
+File Manager is a powerful but familiar tool for managing files. File Manager supports typical operations like cut/copy/paste and supports removable storage where available. File Manager makes effective use of space on small form factor devices, and expands to use more space on larger displays.
+
+File Manager is written in QML and C++ using the Ubuntu SDK and is licensed under the GPLv3.
+
+Useful Links
+============
+
+Here are some useful links with regards to the Filemanager development.
+
+* Home Page     - https://developer.ubuntu.com/en/community/core-apps/file-manager/
+* Project Page  - https://code.launchpad.net/ubuntu-filemanager-app

=== added file 'README.autopilot'
--- README.autopilot	1970-01-01 00:00:00 +0000
+++ README.autopilot	2015-12-23 10:02:03 +0000
@@ -0,0 +1,57 @@
+Running Autopilot tests
+=======================
+
+Ubuntu Clock App follows a test driven development where autopilot tests are
+run before every merge into trunk. If you are submitting your bugfix/patch to
+the clock app, please follow the following steps below to ensure that all tests
+pass before proposing a merge request.
+
+If you are looking for more info about Autopilot or writing AP tests for the
+clock app, here are some useful links to help you:
+
+* http://developer.ubuntu.com/start/quality
+* https://developer.ubuntu.com/api/autopilot/python/1.5.0/
+
+For help and options on running tests, see:
+
+* https://developer.ubuntu.com/en/start/platform/guides/running-autopilot-tests/
+
+Prerequisites
+=============
+
+Install the following autopilot packages required to run the tests,
+    $ sudo apt-get install python3-autopilot libautopilot-qt ubuntu-ui-toolkit-autopilot python3-autopilot-vis
+
+Running tests on the desktop
+============================
+
+Using terminal:
+
+*  Branch the filemanager app code,
+    $ bzr branch lp:ubuntu-filemanager-app
+
+*  Build the filemanager app as outlined in README.developers
+
+*  Navigate to the tests/autopilot directory.
+    $ cd tests/autopilot
+
+*  run all tests.
+    $ autopilot3 run -vv filemanager
+
+    to list all tests:
+    $ autopilot3 list filemanager
+
+
+Running tests on the desktop in phone or tablet mode
+====================================================
+
+You can run filemanager in phone or tablet mode passing one of these two switches:
+
+-p for phone mode
+-t for tablet mode
+
+so:
+
+autopilot3 launch ../../src/app/filemanager -p
+
+will launch filemanager with autopilot in phone mode.
\ No newline at end of file

=== added file 'README.developers'
--- README.developers	1970-01-01 00:00:00 +0000
+++ README.developers	2015-12-23 10:02:03 +0000
@@ -0,0 +1,154 @@
+ReadMe Developers - Ubuntu Filemanager
+===========================
+
+Building and running on Desktop
+===============================
+
+Obtain the source:
+
+	$ bzr branch lp:ubuntu-filemanager-app
+
+Install the following build dependencies:
+
+	$ sudo apt-get install libtag1-dev libpam0g-dev python3
+
+Then open the CMakeLists.txt file in Qt Creator, and ensure that the kit
+selected on the left sidebar (just above the green "Run" button) is "Desktop"
+
+> Starting the App
+
+No additional steps are required before running the app on the desktop.
+
+You can pass two switches to run in phone or tablet mode from the desktop:
+
+-p for phone mode
+-t for tablet mode
+
+Due to Qt Creator's bug #1312094 in launchpad.net, there needs to be a manual
+workaround done before the app can run on the device:
+
+1. Modify the desktop.in file: change the Exec line to read:
+   Exec=lib/arm-linux-gnueabihf/bin/@EXEC@
+
+Remember to revert this temporary change if you are building a click package or
+if you're making other changes to be committed to the code!
+
+Building and running on a Device
+================================
+
+If you don't have one already, you'll need to create an armhf chroot to
+cross-compile the app (also do this if you have an older armhf chroot, for
+example 14.04 and current target is 14.10. You can first delete the old target
+and then create a current one). Here's how:
+
+1. In Qt Creator, open the CMakeLists.txt file
+2. Go to Tools > Options > Ubuntu > Click
+2. Click on Create Click Target
+3. Follow the prompts to generate the chroot. You will be asked for your sudo
+   password
+4. Once created, you'll need to add the build dependencies for the app:
+  - Click on the Maintain button on your chroot
+  - On the terminal prompt that is started, type
+    apt-get install libtag1-dev:armhf libpam0g-dev:armhf python3
+  - Close the terminal when the installation finishes
+5. Now you can either do a clean checkout and wait to be prompted by Qt Creator
+   to add the armhf kit, or alternatively:
+6. Go to the Projects tab > Add kit and then select the UbuntuSDK armhf kit
+
+Additionally, you'll have to tell Qt Creator that you are doing a build for a
+device to ultimately create a click package for installation:
+
+1. In Qt Creator, go to the Projects tab on the sidebar
+2. Click on the "Build" subtab of the "UbuntuSDK for armhf..." tab
+3. Then go to the "CMake arguments" text field and add "-DCLICK_MODE=on"
+   without the quotes
+
+Before starting the build make sure to select the "UbuntuSDK" kit on Qt
+Creator's left sidebar (just above the green "Run" button).
+
+Ensure you've selected the kit you want for your build and press the build
+button on Qt Creator's left sidebar (or alternatively Ctrl+B).
+
+> Starting the App
+
+Ensure you've selected the kit you want for your build and press the run
+button on Qt Creator's left sidebar (or alternatively Ctrl+R).
+
+If the app hasn't been built yet, or if there are pending changes that require
+a build, the app will automatically be built first before running.
+
+If you're starting the app on a device, the build will be copied over and the
+code will run unconfined.
+
+
+Building a click package
+========================
+
+There are two alternative ways of building a click package.
+
+### Using Qt Creator
+
+1. Ensure you've selected the UbuntuSDK for armhf kit on Qt Creator's sidebar
+2. Click on Publish on the sidebar
+3. Click on "Create package"
+4. If all goes well, you'll find the final click package in the build directory
+
+Notes:
+- You can see the output of the click build if you click on Edit on the sidebar
+  and then "Application Output" at the bottom. This is useful to identify any
+  failures during the build
+- Run `sudo apt-get install click-reviewers-tools` to enable click package
+  validation in Qt Creator. You might need to restart Qt Creator after you've
+  installed them for it to detect them
+
+> Using click-buddy
+
+	1. Install phablet-tools: 
+		
+		$ sudo apt-get install phablet-tools
+
+	2. Run click-buddy in your source tree:
+	   
+	   	$ click-buddy --dir . --arch armhf --framework ubuntu-sdk-14.04
+
+	3. Once finished, click-buddy will tell you the location of your source package
+
+> Installing a click package
+
+First of all, ensure you've got a working Ubuntu device attached over USB to
+your host computer
+
+>> Manually
+
+Run the following commands to manually install the click package (replace 0.5
+with the version of your package):
+
+    $ adb push com.ubuntu.filemanager_0.3.latest_armhf.click /home/phablet/
+    $ adb shell
+    $ sudo -H -u phablet pkcon install-local /home/phablet/com.ubuntu.filemanager_0.3_armhf.click
+
+>> Using click-buddy
+
+You can add the --provision argument to the previous command to install the
+click package on the device.
+
+>> Starting the app
+
+1. Either kill unity8 with `pkill unity8` or restart the system for the Apps
+   (click) scope to pick up your newly installed click package
+2. Search for Reminders in the Apps scope and tap on its icon to start it
+3. You'll find the runtime logs at ~/.cache/upstart/application-click/
+
+> Uninstalling a click package
+
+Run the following commands, replacing the version of the click package you want
+to uninstall:
+
+    $ adb shell
+    $ sudo -iu phablet
+    $ sudo click unregister com.ubuntu.filemanager 0.3
+
+Running Tests
+=============
+
+Please check README.autopilot on how to run tests.
\ No newline at end of file

=== modified file 'README.translations'
--- README.translations	2014-08-16 07:04:04 +0000
+++ README.translations	2015-12-23 10:02:03 +0000
@@ -1,4 +1,7 @@
-# Updating translations
+ReadMe Translations - Ubuntu Filemanager
+===========================
+
+> Updating translations
 
 Translations for the Filemanager app happen in [Launchpad Translations][] and
 are automatically committed daily on the trunk branch in the po/ folder.
@@ -10,14 +13,19 @@
 translatable messages to translators. So whenever you add new translatable
 messages in the code, make sure to follow these steps:
 
- 1. Run click-buddy retaining the build directory:
-    `click-buddy --dir . --no-clean`
- 2. Commit the generated .pot file: `bzr commit -m"Updated translation template"`
- 3. Push the branch and send a merge proposal as usual
+	 1. Run click-buddy retaining the build directory:
+
+	    	$ click-buddy --dir . --no-clean
+	 
+	 2. Commit the generated .pot file: 
+
+	 		$ bzr commit -m"Updated translation template"
+	 
+	 3. Push the branch and send a merge proposal as usual
 
 And that's it, once the branch lands Launchpad should take care of all the rest!
 
-# Behind the scenes
+> Behind the scenes
 
 Behind the scenes, whenever the po/*.pot file (also known as translations template)
 is committed to trunk Launchpad reads it and updates the translatable strings