Merge lp:~stephen-stewart/snappy/fix-typos-in-config-docs into lp:~snappy-dev/snappy/snappy-moved-to-github

Proposed by Stephen Stewart
Status: Merged
Approved by: John Lenton
Approved revision: 456
Merged at revision: 456
Proposed branch: lp:~stephen-stewart/snappy/fix-typos-in-config-docs
Merge into: lp:~snappy-dev/snappy/snappy-moved-to-github
Diff against target: 84 lines (+15/-18)
1 file modified
docs/config.md (+15/-18)
To merge this branch: bzr merge lp:~stephen-stewart/snappy/fix-typos-in-config-docs
Reviewer Review Type Date Requested Status
John Lenton (community) Approve
Review via email: mp+259027@code.launchpad.net

Commit message

fix typos

To post a comment you must log in.
456. By Stephen Stewart

remove double space

Revision history for this message
John Lenton (chipaca) wrote :

Also some polish! thanks :)

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'docs/config.md'
2--- docs/config.md 2015-04-22 13:08:08 +0000
3+++ docs/config.md 2015-05-13 17:14:50 +0000
4@@ -3,13 +3,13 @@
5
6 The snappy config command is a mechanism for package to provide a way
7 to set and get its configuration. A standard yaml based protocol is
8-used for the interaction. The application is repsonsible to provide a
9-configuration handler that can transform yaml into the apps native
10+used for the interaction. The application is responsible for providing
11+a configuration handler that can transform yaml into the app's native
12 configuration format.
13
14-We plan to support a schema file for the yaml as well to make e.g. web
15-based editing of the config simpler. The format of the configuration
16-is as follows:
17+We plan also to support a schema file for the yaml to make editing
18+simpler, for example web based editing of config. The format of the
19+configuration is as follows:
20
21 config:
22 packagename:
23@@ -18,8 +18,8 @@
24 key: value
25
26 The application provides a configuration handler in
27-meta/hooks/config. This configuration handler must provide reading new
28-configuration from stdin and output the current configuration (after
29+meta/hooks/config. This configuration handler must provide for reading
30+new configuration from stdin and output the current configuration (after
31 the new configuration has been applied) to stdout.
32
33 The package config hook must return exitcode 0 and return valid yaml
34@@ -39,16 +39,15 @@
35 - error: optional error string
36 - warning: optional warning string
37
38-Some key/value pairs in the configuration are fixed and all
39-applications. E.g. all applications that listen to a port must support
40-the "ports" config option.
41+Some key/value pairs in the configuration are fixed, for example all
42+applications that listen to a port must support the "ports" config option.
43
44-The current list of values that must be supported (if the feature is used:
45+The current list of values that must be supported (if the feature is used):
46
47 - ports: the listen ports (if the application listens to the network)
48
49-When the configuratin is applied the service will be restarted by
50-snappy automatically(?).
51+When the configuration is applied the service will be restarted by
52+snappy automatically.
53
54 Examples:
55 ---------
56@@ -69,7 +68,7 @@
57
58 Example to get a config:
59
60-snappy calls meta/hooks/config with empty input. The meta/hooks/config sends
61+snappy calls meta/hooks/config with empty input. The meta/hooks/config sends
62 the following back:
63
64 config:
65@@ -82,17 +81,15 @@
66 Example to set a non-existing config:
67
68 snappy -> meta/hooks/config
69-
70+
71 config:
72 ubuntu-core:
73 tea-in-the-morning: false
74
75 meta/hooks/config exit with status 10 and message:
76-
77+
78 status:
79 ubuntu-core:
80 error: Unknown config option "tea-in-the-morning"
81
82 [snappy fails the install of the app]
83-
84-

Subscribers

People subscribed via source and target branches