summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNeil Williams <codehelp@debian.org>2015-11-06 16:09:22 +0000
committerNeil Williams <codehelp@debian.org>2015-11-06 16:09:22 +0000
commit1ec79b9c84463a24519302664e2f2853e93e09df (patch)
tree9c9ba5c432577645d1fd4b01817e48e84757209f /doc
parent87a9b1d1b66e17850ae64cbcf5f3282abbdfb4a7 (diff)
downloadvmdebootstrap-1ec79b9c84463a24519302664e2f2853e93e09df.tar.gz
Fix sphinx errors
Diffstat (limited to 'doc')
-rw-r--r--doc/live.rst2
-rw-r--r--doc/overview.rst26
2 files changed, 16 insertions, 12 deletions
diff --git a/doc/live.rst b/doc/live.rst
index a1b1b2d..3c5a05d 100644
--- a/doc/live.rst
+++ b/doc/live.rst
@@ -69,7 +69,7 @@ to vmdebootstrap to ensure that the user is added to the sudo group. The
root user password should also be locked (--lock-root-password).
* Consider using a blank password and enforcing a password to be set
- upon login for those images which can support this.
+ upon login for those images which can support this.
``mksquashfs`` can fail without indication of why and when it does, the image
file can be 4Kb or so of junk. ``vmdebootstrap`` will fail if the
diff --git a/doc/overview.rst b/doc/overview.rst
index c493477..1bdd8e0 100644
--- a/doc/overview.rst
+++ b/doc/overview.rst
@@ -34,7 +34,7 @@ Synopsis
$ sudo vmdebootstrap --image=FILE --size=SIZE [--mirror=URL] [--distribution=NAME]
Options
-*******
+=======
--output=FILE write output to FILE, instead of standard output
--verbose report what is going on
@@ -165,16 +165,6 @@ Logging
--log-keep=N keep last N logs (10)
--log-mode=MODE set permissions of new log files to MODE (octal; default 0600)
-Developing
-**********
-
-Testing vmdebootstrap from git
-------------------------------
-
-::
-
- ln -s ../../pre-commit.sh .git/hooks/pre-commit
-
Peformance
**********
@@ -184,6 +174,20 @@ Peformance
--memory-dump-interval=SECONDS
make memory profiling dumps at least SECONDS apart
+Developing
+**********
+
+.. index:: pre-commit
+
+.. _pre_commit_hook:
+
+Testing vmdebootstrap from git
+==============================
+
+::
+
+ ln -s ../../pre-commit.sh .git/hooks/pre-commit
+
.. index:: networking
.. _networking: