summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrett Holman <brett.holman@canonical.com>2022-11-10 12:34:35 -0700
committerGitHub <noreply@github.com>2022-11-10 13:34:35 -0600
commit7f045647ceae58f3fb69b1f31cab4ac322f62501 (patch)
treecd87d286918dcfac644e3476ba1b6937f303707a
parentd8278b231c9749538875961e3938bd1fcd8b3d8d (diff)
downloadcloud-init-git-7f045647ceae58f3fb69b1f31cab4ac322f62501.tar.gz
cc_grub: reword docs for clarity (#1818)
Remove inaccurate statement from docs
-rw-r--r--cloudinit/config/cc_grub_dpkg.py7
1 files changed, 3 insertions, 4 deletions
diff --git a/cloudinit/config/cc_grub_dpkg.py b/cloudinit/config/cc_grub_dpkg.py
index 0572f72e..893204fa 100644
--- a/cloudinit/config/cc_grub_dpkg.py
+++ b/cloudinit/config/cc_grub_dpkg.py
@@ -21,10 +21,9 @@ from cloudinit.subp import ProcessExecutionError
MODULE_DESCRIPTION = """\
Configure which device is used as the target for grub installation. This module
-should work correctly by default without any user configuration. It can be
-enabled/disabled using the ``enabled`` config key in the ``grub_dpkg`` config
-dict. The global config key ``grub-dpkg`` is an alias for ``grub_dpkg``. If no
-installation device is specified this module will execute grub-probe to
+can be enabled/disabled using the ``enabled`` config key in the ``grub_dpkg``
+config dict. The global config key ``grub-dpkg`` is an alias for ``grub_dpkg``.
+If no installation device is specified this module will execute grub-probe to
determine which disk the /boot directory is associated with.
The value which is placed into the debconf database is in the format which the