Merge ~sbright/cloud-init:various-doc-fixes into cloud-init:master

Proposed by Sean Bright
Status: Merged
Merged at revision: 7e586f0d4f59a5051f8723e6bbdd06466d19729e
Proposed branch: ~sbright/cloud-init:various-doc-fixes
Merge into: cloud-init:master
Diff against target: 98 lines (+10/-8)
6 files modified
cloudinit/config/cc_apt_configure.py (+4/-2)
cloudinit/config/cc_bootcmd.py (+1/-1)
doc/examples/cloud-config-boot-cmds.txt (+1/-1)
doc/rtd/topics/boot.rst (+2/-2)
doc/rtd/topics/format.rst (+1/-1)
doc/rtd/topics/logging.rst (+1/-1)
Reviewer Review Type Date Requested Status
cloud-init Commiters Pending
Review via email: mp+311313@code.launchpad.net

Commit message

Various minor fixes for the RTD documentation

Description of the change

Various minor fixes for the RTD documentation.

To post a comment you must log in.
ed4c0dd... by Sean Bright

Doc: 'cloud-nit-per' -> 'cloud-init-per'

ffa20a1... by Sean Bright

Doc: remove reference to non-existant 'cloud-init-boot-per'

Revision history for this message
Jon Grimm (jgrimm) wrote :

LGTM. Nice catches!

9cd832f... by Sean Bright

Doc: Fix apt-configure example YAML

0cfe7b2... by Sean Bright

Doc: Add debconf_selections example

Revision history for this message
Scott Moser (smoser) wrote :

I merged up to your
 https://git.launchpad.net/~sbright/cloud-init/commit/?id=9cd832fcbdb2da9e628b2d2c3e6b96b99ff8c41b

Please feel free to make more merge requests with additional changes.

Thank you!

Update scan failed

At least one of the branches involved have failed to scan. You can manually schedule a rescan if required.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/cloudinit/config/cc_apt_configure.py b/cloudinit/config/cc_apt_configure.py
2index 6145fcd..eb1db70 100644
3--- a/cloudinit/config/cc_apt_configure.py
4+++ b/cloudinit/config/cc_apt_configure.py
5@@ -199,6 +199,8 @@ The ``source`` key supports variable replacements for the following strings:
6 deb-src $MIRROR $RELEASE main restricted
7 deb $PRIMARY $RELEASE universe restricted
8 deb $SECURITY $RELEASE-security multiverse
9+ debconf_selections:
10+ set1: the-package the-package/some-flag boolean true
11 conf: |
12 APT {
13 Get {
14@@ -216,9 +218,9 @@ The ``source`` key supports variable replacements for the following strings:
15 keyserver: "keyserverurl"
16 source: "deb http://<url>/ xenial main"
17 source2:
18- source "ppa:<ppa-name>"
19+ source: "ppa:<ppa-name>"
20 source3:
21- source "deb $MIRROR $RELEASE multiverse"
22+ source: "deb $MIRROR $RELEASE multiverse"
23 key: |
24 ------BEGIN PGP PUBLIC KEY BLOCK-------
25 <key data>
26diff --git a/cloudinit/config/cc_bootcmd.py b/cloudinit/config/cc_bootcmd.py
27index 22b23f2..291ac6e 100644
28--- a/cloudinit/config/cc_bootcmd.py
29+++ b/cloudinit/config/cc_bootcmd.py
30@@ -43,7 +43,7 @@ specified either as lists or strings. For invocation details, see ``runcmd``.
31
32 bootcmd:
33 - echo 192.168.1.130 us.archive.ubuntu.com > /etc/hosts
34- - [ cloud-nit-per, once, mymkfs, mkfs, /dev/vdb ]
35+ - [ cloud-init-per, once, mymkfs, mkfs, /dev/vdb ]
36 """
37
38 import os
39diff --git a/doc/examples/cloud-config-boot-cmds.txt b/doc/examples/cloud-config-boot-cmds.txt
40index 5c05bef..84e487a 100644
41--- a/doc/examples/cloud-config-boot-cmds.txt
42+++ b/doc/examples/cloud-config-boot-cmds.txt
43@@ -9,7 +9,7 @@
44 # boothook, but possibly with more friendly.
45 # - bootcmd will run on every boot
46 # - the INSTANCE_ID variable will be set to the current instance id.
47-# - you can use 'cloud-init-boot-per' command to help only run once
48+# - you can use 'cloud-init-per' command to help only run once
49 bootcmd:
50 - echo 192.168.1.130 us.archive.ubuntu.com >> /etc/hosts
51 - [ cloud-init-per, once, mymkfs, mkfs, /dev/vdb ]
52diff --git a/doc/rtd/topics/boot.rst b/doc/rtd/topics/boot.rst
53index 9d42336..859409a 100644
54--- a/doc/rtd/topics/boot.rst
55+++ b/doc/rtd/topics/boot.rst
56@@ -21,7 +21,7 @@ boot goals. By default, this generator will enable cloud-init. It will
57 not enable cloud-init if either:
58
59 * A file exists: ``/etc/cloud/cloud-init.disabled``
60- * The kernel command line as fond in /proc/cmdline contains ``cloud-init=disabled``.
61+ * The kernel command line as found in /proc/cmdline contains ``cloud-init=disabled``.
62 When running in a container, the kernel command line is not honored, but
63 cloud-init will read an environment variable named ``KERNEL_CMDLINE`` in
64 its place.
65@@ -56,7 +56,7 @@ is rendered. This includes clearing of all previous (stale) configuration
66 including persistent device naming with old mac addresses.
67
68 This stage must block network bring-up or any stale configuration might
69-already have been applied. That could have negative effects such as DCHP
70+already have been applied. That could have negative effects such as DHCP
71 hooks or broadcast of an old hostname. It would also put the system in
72 an odd state to recover from as it may then have to restart network
73 devices.
74diff --git a/doc/rtd/topics/format.rst b/doc/rtd/topics/format.rst
75index 5898d17..ed87d3e 100644
76--- a/doc/rtd/topics/format.rst
77+++ b/doc/rtd/topics/format.rst
78@@ -9,7 +9,7 @@ Gzip Compressed Content
79
80 Content found to be gzip compressed will be uncompressed.
81 The uncompressed data will then be used as if it were not compressed.
82-This is typically is useful because user-data is limited to ~16384 [#]_ bytes.
83+This is typically useful because user-data is limited to ~16384 [#]_ bytes.
84
85 Mime Multi Part Archive
86 =======================
87diff --git a/doc/rtd/topics/logging.rst b/doc/rtd/topics/logging.rst
88index c6afca1..4fd7e28 100644
89--- a/doc/rtd/topics/logging.rst
90+++ b/doc/rtd/topics/logging.rst
91@@ -22,7 +22,7 @@ output to ``tee``, or ``logger``. If only a filename is provided, cloud-init
92 will append its output to the file as though ``>>`` was specified.
93
94 By default, cloud-init loads its output configuration from
95-``/etc/cloud/coud.cfg.d/05_logging.cfg``. The default config directs both
96+``/etc/cloud/cloud.cfg.d/05_logging.cfg``. The default config directs both
97 stdout and stderr from all cloud-init stages to
98 ``/var/log/cloud-init-output.log``. The default config is given as ::
99

Subscribers

People subscribed via source and target branches