Merge lp:~thomas-voss/location-service/iterate-on-docs into lp:location-service

Proposed by Thomas Voß
Status: Merged
Approved by: Thomas Voß
Approved revision: 289
Merged at revision: 289
Proposed branch: lp:~thomas-voss/location-service/iterate-on-docs
Merge into: lp:location-service
Diff against target: 86 lines (+16/-16)
2 files modified
doc/cli.md (+7/-7)
doc/intro.md (+9/-9)
To merge this branch: bzr merge lp:~thomas-voss/location-service/iterate-on-docs
Reviewer Review Type Date Requested Status
Simon Fels (community) Approve
Thomas Voß Pending
Review via email: mp+315873@code.launchpad.net

Commit message

Adjust formatting and rename to locationd in docs.

Description of the change

Adjust formatting and rename to locationd in docs.

To post a comment you must log in.
Revision history for this message
Simon Fels (morphis) wrote :

LGTM

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'doc/cli.md'
2--- doc/cli.md 2016-12-09 12:36:42 +0000
3+++ doc/cli.md 2017-01-30 09:10:10 +0000
4@@ -1,14 +1,14 @@
5 # CLI
6
7-The location service offers a command-line interface for controlling
8+locationd offers a command-line interface for controlling
9 and monitoring the service. The following commands are available:
10
11- - list: Lists all provider implementations known to the service.
12- - monitor: Connects to a location service instance, monitoring its activity.
13- - provider: Executes a known provider implementation in an out-of-process sandbox.
14- - run: Executes the service.
15- - status: Queries the status of a service instance.
16- - test: Executes runtime tests against known provider implementations.
17+ - `list`: Lists all provider implementations known to the service.
18+ - `monitor`: Connects to a locationd instance, monitoring its activity.
19+ - `provider`: Executes a known provider implementation in an out-of-process sandbox.
20+ - `run`: Executes the service.
21+ - `status`: Queries the status of a service instance.
22+ - `test`: Executes runtime tests against known provider implementations.
23
24 For all of the commands, an exit status of 0 indicates success. An exit status of 1 indicates
25 an error. Normal output goes to stdout, while all errors/warnings are output to stderr.
26
27=== modified file 'doc/intro.md'
28--- doc/intro.md 2016-09-22 10:46:17 +0000
29+++ doc/intro.md 2017-01-30 09:10:10 +0000
30@@ -1,6 +1,6 @@
31 # Introduction
32
33-Ubuntu's location service is a central hub for multiplexing access to
34+locationd is a central hub for multiplexing access to
35 positioning subsystems available via hard- and software. It provides a
36 client API offering positioning capabilities to applications and other
37 system components, abstracting away the details of individual
38@@ -11,25 +11,25 @@
39 To make the remainder of this documentation as easily understandable
40 as possible, we start over with introducing some vocabulary:
41
42- - Engine: Responsible for handling input from multiple positioning
43+ - `Engine`: Responsible for handling input from multiple positioning
44 subsystems and maintaining the state of the overall system. Think
45 about it like the heart of the system.
46
47- - Provider: A positioning subsystem that feeds into the positioning
48+ - `Provider`: A positioning subsystem that feeds into the positioning
49 engine. Common examples are a GPS provider or a network-based
50 positioning provider.
51
52- - Service: The point of entry for applications and services that would
53+ - `Service`: The point of entry for applications and services that would
54 like to receive position data.
55
56- - Session: In order to receive position information, every application
57+ - `Session`: In order to receive position information, every application
58 or service has to create a session with the location Service.
59 Session creation is subject to security mediation and contextual
60 prompting.
61
62-- Update: An update is a timestamped entity to a certain type of data.
63+ - `Update`: An update is a timestamped entity to a certain type of data.
64
65-- [WGS84](http://en.wikipedia.org/wiki/World_Geodetic_System): The coordinate system that is used throughout the entire location subsystem.
66+ - [WGS84](http://en.wikipedia.org/wiki/World_Geodetic_System): The coordinate system that is used throughout the entire location subsystem.
67
68 ## Architectural Overview
69
70@@ -60,14 +60,14 @@
71 ## Privacy & Access Control
72
73 Location information is highly privacy relevant. For this reason, the
74-location service is deeply integrated with AppArmor and Ubuntu's
75+locationd is deeply integrated with AppArmor and Ubuntu's
76 overall trust infrastructure. Every incoming session request is
77 validated and if in doubt, the user is asked to explicitly grant trust
78 to the application requesting access to positioning
79 information. Please see [@ref com::ubuntu::location::service::PermissionManager]
80 for further details.
81
82-In addition, the location service allows for selectively adjusting the
83+In addition, the locationd allows for selectively adjusting the
84 accuracy and reporting setup of the location Engine to provide further
85 fine-grained control over the exposed data to user. Within this setup,
86 a user is able to entirely disable all positioning.

Subscribers

People subscribed via source and target branches

to all changes: