Features/Feature Template

From Sugar Labs
< Features
Revision as of 08:58, 20 June 2009 by Erikos (talk | contribs)
Jump to navigation Jump to search

<Feature Name>

(Template based on http://fedoraproject.org/wiki/Features/DeviceKit.)

Summary

<Feature Name> is a simple system service that a) can enumerate devices; b) emits signals when devices are added removed; c) provides a way to merge device information / quirks onto devices. It is designed to partially replace hal and overcome some of the design limitiations of hal. DeviceKit functionality is provided in the form of dbus services on the system bus.

Apart from DeviceKit itself, there is DeviceKit-disks, which is a system service to keep track of block devices. The functionality offered by DeviceKit-disks is a superset of what hal provides for block devices.

There is also DeviceKit-power, which takes over the power-management-related parts of hal and the more complex functionality of gnome-power-manager. As a consequence, gnome-power-manager itself becomes much simpler.

The new udev-extra module will provide udev rules that are needed to make the DeviceKit architecture work. Functionality that was provided via .fdi files in hal will eventually be moved to udev rules, and setting acls on devices will also be done here at some point.

DeviceKit-disks comes with a graphical frontend called palimpsest (the package name is gnome-disk-utility). Furthermore, there's a nautilus extension to format disks (nautilus-gdu), accessible from context menu.

Champions

Owner/Coordinator, other developers, designers, contributors

Current status

  • Targeted release: Sugar 0.86
  • Last updated: 2009-06-20
  • Percentage of completion: 0%

DeviceKit, DeviceKit-disks, DeviceKit-power and gnome-disk-utility (i.e. palimpsest) packages have been built in rawhide.

gnome-power-manager 2.25 in rawhide uses DeviceKit-power instead of hal.

The port of gvfs to DeviceKit-disks is in rawhide.

udev-extras is hosted on kernel.org and has been packaged for rawhide.

The nautilus extension for disk formatting is being worked on here. It is called nautilus-gdu. It is available in rawhide.

Still todo:

  • remove the properties page from gnome-mount
  • add a status icon for smart warnings, critical raid events and delayed write warnings
  • bug fixes

Detailed Description

David has written an extensive explanation of the DeviceKit architecture, and the motivation for rewriting hal. Read all about it here

There is a dedicated devkit-devel mailing list now.

Benefit to Sugar

Sugar gains a comprehensive graphical disk management tool which provides functionality that so far was almost exclusively available in the partitioning screen of anaconda. The tools integrate nicely into the desktop (by e.g. providing a "Format disk..." menuitem in the nautilus context menu where appropriate).

Scope

DeviceKit depends on bug fixes and enhancements in the following components: kernel, udev, mdadm, and lvm. These will have to appear in rawhide first.

Also, in order to peacefully coexist with DeviceKit-disks, at a very minimum hal needs to talk to DeviceKit-disks about locking and mounting/unmounting. Medium term, hal functionality such as disk and power-management support will be turned off when all important users have been ported over to the equivalent DeviceKit api.

The core components that we plan to port for F11 are: gvfs, gnome-mount, nautilus and gnome-power-manager.

For completeness, [1] is a list of all packages in Fedora that depend on hal, libhal.so.1 or libhal-storage.so.1. Except where noted, we don't expect to port these to DeviceKit for F11.

How To Test

  1. yum install gnome-disk-utility. This will pull in DeviceKit-disks and DeviceKit via dependencies.
  2. Use palimpsest (the graphical frontend) to create, modify and delete partitions and file systems on various media, such as usb sticks, cds, removable hard disks, etc.
  3. Use palimpsest to encrypt partitions and to change passwords for existing encrypted partitions.
  4. Use nautilus-gdu to format removable media with various file system types.
  5. Verify that palimpsest correctly reports smart data from disks which support it.
  6. Test the raid support
  7. Test that desktop applications like nautilus and the gedit's file chooser see volumes and mounts
  8. Check that gnome-power-manager provides the same functionality it had in previous releases
  9. Similar for other desktop environments and applications, if they are ported to DeviceKit

User Experience

There is a new menu item that brings up palimpsest: Applications → System Tools → Palimpsest Disk Utility

The nautilus context menu offers to format discs/usb sticks and other devices. palimpsest is a graphical interface for all disc-related tasks, from partitioning and file system creation to encryption, raid and lvm.

Here are some screenshots of palimpsest and nautilus-gdu in action:

  • The main window

File:Palimpsest1.png

  • SMART details

File:Palimpsest2.png

  • PolicyKit integration

File:Palimpsest3.png

  • The nautilus-gdu dialog

File:Nautilus-gdu.png

Dependencies

Contingency Plan

DeviceKit-disks and DeviceKit-power can coexist with the disk and power management parts of hal. If the porting of applications is not complete by F11, we don't strip the functionality out of hal in F11.

Documentation

Sugar API: http://api.sugarlabs.org/

Repository: http://git.sugarlabs.org/projects/webified/


API docs are here: http://hal.freedesktop.org/docs/DeviceKit/

http://hal.freedesktop.org/docs/DeviceKit-disks/

http://hal.freedesktop.org/docs/DeviceKit-power/

End user documentation will take some time to write, and can't really be started before the tools are publicly available.

Release Notes

Sugar 0.86 features NAME, which is a simpler, modular replacement...

Comments and Discussion

See Talk:Development Team/Feature Template

Retrieved from "https://wiki.sugarlabs.org/index.php?title=Features/Feature_Template&oldid=30781"