From 31d98be0dc493620e28ad9bd24d3889499333b50 Mon Sep 17 00:00:00 2001 From: Neil Williams Date: Mon, 31 Aug 2015 20:33:07 +0100 Subject: add index and references to the docs --- doc/overview.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'doc/overview.rst') diff --git a/doc/overview.rst b/doc/overview.rst index 09356c5..8194666 100644 --- a/doc/overview.rst +++ b/doc/overview.rst @@ -1,8 +1,13 @@ VMDebootstrap ############# +.. index:: purpose + +.. _purpose: + Purpose ******* + vmdebootstrap is a helper to install basic Debian system into virtual disk image. It wraps **debootstrap**. You need to run :file:`vmdebootstrap` as root. If the ``--verbose`` option is not used, no output will be @@ -17,6 +22,10 @@ to configure it. The image has an empty root password and will not have networking configured by default. Set the root password before you configure networking. +.. index:: networking + +.. _networking + Networking ********** @@ -35,6 +44,10 @@ into :file:`/etc/network/interfaces.d/setup`:: auto eth0 iface eth0 inet dhcp +.. index:: bootloaders + +.. _bootloaders: + Bootloaders *********** @@ -42,6 +55,8 @@ Unless the ``--no-extlinux`` or ``--grub`` options are specified, the image will use ``extlinux`` as a boot loader. ``bootsize`` is not recommended when using ``extlinux`` - use ``grub`` instead. +.. _wheezy_grub: + Versions of grub2 in wheezy =========================== @@ -63,6 +78,10 @@ not supported as it would need to be done after boot. If the system you are creating is for more than just a VM or live image, you will likely need a larger ESP, up to 500Mb. +.. index: uboot + +.. _uboot: + UBoot ===== @@ -71,6 +90,8 @@ typically support requires adding ``u-boot`` using ``--package`` and then copying or manipulating the relevant ``u-boot`` files in the customisation script. Examples are included for beaglebone-black. +.. _installation_images: + Installation images and virtual machines **************************************** -- cgit v1.2.1