summaryrefslogtreecommitdiff
path: root/cloudinit
diff options
context:
space:
mode:
authorShane Frasier <maverick@maverickdolphin.com>2020-11-03 12:12:42 -0500
committerGitHub <noreply@github.com>2020-11-03 12:12:42 -0500
commit8dfd8801ab1329efe066876c037f71a73dcf3de1 (patch)
tree965c2c761ce0ab00a036b7e8a1ae8ea4d9d256fc /cloudinit
parent0184e53648ca62072c32de3f0de3cc7c91c27d99 (diff)
downloadvyos-cloud-init-8dfd8801ab1329efe066876c037f71a73dcf3de1.tar.gz
vyos-cloud-init-8dfd8801ab1329efe066876c037f71a73dcf3de1.zip
Make some language improvements in growpart documentation (#649)
* Fix awkward English in sentence * Add the missing word "the" * Fix misspelling * Add @jsf9k as a contributor Co-authored-by: Rick Harding <rharding@mitechie.com>
Diffstat (limited to 'cloudinit')
-rw-r--r--cloudinit/config/cc_growpart.py11
1 files changed, 6 insertions, 5 deletions
diff --git a/cloudinit/config/cc_growpart.py b/cloudinit/config/cc_growpart.py
index 621df0ac..9f338ad1 100644
--- a/cloudinit/config/cc_growpart.py
+++ b/cloudinit/config/cc_growpart.py
@@ -16,12 +16,13 @@ This is useful for cloud instances with a larger amount of disk space available
than the pristine image uses, as it allows the instance to automatically make
use of the extra space.
-The devices run growpart on are specified as a list under the ``devices`` key.
-Each entry in the devices list can be either the path to the device's
-mountpoint in the filesystem or a path to the block device in ``/dev``.
+The devices on which to run growpart are specified as a list under the
+``devices`` key. Each entry in the devices list can be either the path to the
+device's mountpoint in the filesystem or a path to the block device in
+``/dev``.
The utility to use for resizing can be selected using the ``mode`` config key.
-If ``mode`` key is set to ``auto``, then any available utility (either
+If the ``mode`` key is set to ``auto``, then any available utility (either
``growpart`` or BSD ``gpart``) will be used. If neither utility is available,
no error will be raised. If ``mode`` is set to ``growpart``, then the
``growpart`` utility will be used. If this utility is not available on the
@@ -34,7 +35,7 @@ where one tool is able to function and the other is not. The default
configuration for both should work for most cloud instances. To explicitly
prevent ``cloud-initramfs-tools`` from running ``growroot``, the file
``/etc/growroot-disabled`` can be created. By default, both ``growroot`` and
-``cc_growpart`` will check for the existance of this file and will not run if
+``cc_growpart`` will check for the existence of this file and will not run if
it is present. However, this file can be ignored for ``cc_growpart`` by setting
``ignore_growroot_disabled`` to ``true``. For more information on
``cloud-initramfs-tools`` see: https://launchpad.net/cloud-initramfs-tools