[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Random notes about possible improvements to the installation guide



Hi!

While reading the i386 installation guide from cover to cover, I have
taken some notes about some changes that could improve it.

If anyone feels like working on this, just do it.  You can just apply
the attached patch and grep for "XXX" and "TODO" to find all the
little things on which you could write.

Having an installation guide in shape is a must for Lenny, and sooner
that later would be a lot better for translators.

Cheers,
-- 
Jérémy Bobbio                        .''`. 
lunar@debian.org                    : :Ⓐ  :  # apt-get install anarchism
                                    `. `'` 
                                      `-   
diff --git a/manual/build/entities/common.ent b/manual/build/entities/common.ent
index 406bba3..c69f061 100644
--- a/manual/build/entities/common.ent
+++ b/manual/build/entities/common.ent
@@ -116,7 +116,7 @@ install recommended packages while selecting a task from aptitude will.
 
 <!-- Number of current Debian developers -->
 <!-- Can be found for example on vote.debian.org (use last vote) -->
-<!ENTITY num-of-debian-developers "1075">
+<!ENTITY num-of-debian-developers "1075"> <!-- XXX: update -->
 
 <!-- Number of current Debian maillists -->
 <!ENTITY num-of-debian-maillists "215">
diff --git a/manual/en/appendix/files.xml b/manual/en/appendix/files.xml
index 4f28961..804237b 100644
--- a/manual/en/appendix/files.xml
+++ b/manual/en/appendix/files.xml
@@ -48,6 +48,8 @@ The most important device files are listed in the tables below.
 </row>
 </tbody></tgroup></informaltable>
 
+<!-- XXX: mention USB, SATA and Firewire here -->
+
 <informaltable><tgroup cols="2"><tbody>
 <row>
   <entry><filename>sda</filename></entry>
diff --git a/manual/en/appendix/preseed.xml b/manual/en/appendix/preseed.xml
index e96adeb..0cd4fbf 100644
--- a/manual/en/appendix/preseed.xml
+++ b/manual/en/appendix/preseed.xml
@@ -251,6 +251,8 @@ load it.
 
 </para><para>
 
+<!-- XXX: filename might have changed now we have have the boot menu -->
+
 For the other preseeding methods you need to tell the installer what file
 to use when you boot it. This is normally done by passing the kernel a boot
 parameter, either manually at boot time or by editing the bootloader
@@ -1515,5 +1517,6 @@ network comes up.
 </para>
 
   </sect2>
+  <!-- XXX: add a section on how to upgrade preseeding files from Etch -->
  </sect1>
 </appendix>
diff --git a/manual/en/boot-installer/x86.xml b/manual/en/boot-installer/x86.xml
index 6107d90..a40807c 100644
--- a/manual/en/boot-installer/x86.xml
+++ b/manual/en/boot-installer/x86.xml
@@ -227,6 +227,8 @@ computer.  The system should boot up, and you should be presented with
 the <prompt>boot:</prompt> prompt.  Here you can enter optional boot
 arguments, or just hit &enterkey;.
 
+<!-- XXX: this prompt is now a graphical menu -->
+
 </para>
   </sect2>
 
@@ -339,6 +341,8 @@ provides bootdiskettes and even bootroms that do a TFTPboot.
   <title>The Boot Screen</title>
 <para>
 
+<!-- XXX: mention that it'll beep -->
+
 When the installer boots, you should be presented with a friendly graphical
 screen showing the Debian logo and a menu:
 
@@ -421,6 +425,8 @@ console of Compaq's <quote>integrated Lights Out</quote> (iLO) and HP's
 
 </para><para>
 
+<!-- XXX: mention the beep -->
+
 To bypass the graphical boot screen you can either blindly press &escapekey;
 to get a text boot prompt, or (equally blindly) press <quote>H</quote>
 followed by &enterkey; to select the <quote>Help</quote> option described
diff --git a/manual/en/hardware/hardware-supported.xml b/manual/en/hardware/hardware-supported.xml
index a1aa99e..69fe7f8 100644
--- a/manual/en/hardware/hardware-supported.xml
+++ b/manual/en/hardware/hardware-supported.xml
@@ -31,6 +31,7 @@ variations of each architecture known as <quote>flavors</quote>.
 
 </para><para>
 
+<!-- XXX: check and update -->
 <informaltable>
 <tgroup cols="4">
 <thead>
@@ -281,6 +282,7 @@ Laptops are also supported.  Laptops are often specialized or contain
 proprietary hardware.  To see if your particular laptop works well
 with GNU/Linux, see the
 <ulink url="&url-x86-laptop;">Linux Laptop pages</ulink>
+<!-- XXX: mention ThinkWiki? others? -->
 
 </para>
    </sect2>
diff --git a/manual/en/hardware/installation-media.xml b/manual/en/hardware/installation-media.xml
index 7348d5e..7669672 100644
--- a/manual/en/hardware/installation-media.xml
+++ b/manual/en/hardware/installation-media.xml
@@ -18,6 +18,8 @@ you reach that section.
   <sect2 condition="supports-floppy-boot"><title>Floppies</title>
 <para>
 
+<!-- XXX: if we can't fix floppy method, just mention it for firmware and extra
+udebs -->
 In some cases, you'll have to do your first boot from floppy disks.
 Generally, all you will need is a
 high-density (1440 kilobytes) 3.5 inch floppy drive.
@@ -104,6 +106,8 @@ Booting the installation system directly from a hard disk is another option
 for many architectures. This will require some other operating system
 to load the installer onto the hard disk.
 
+<!-- XXX: add win32-loader here? -->
+
 </para><para arch="m68k">
 
 In fact, installation from your local disk is the preferred
@@ -175,6 +179,8 @@ linkend="linux-upgrade"/>.
 
 <para>
 
+<!-- XXX: now that everything are modules, the kernel isn't *that* large in
+itself, so the following could be mitigated a little bit -->
 The Debian boot disks contain a kernel which is built to maximize the
 number of systems it runs on.  Unfortunately, this makes for a larger
 kernel, which includes many drivers that won't be used for your
diff --git a/manual/en/hardware/network-cards.xml b/manual/en/hardware/network-cards.xml
index ea779f3..a817bd0 100644
--- a/manual/en/hardware/network-cards.xml
+++ b/manual/en/hardware/network-cards.xml
@@ -94,6 +94,8 @@ supported; Spellcaster BRI ISDN boards are also not supported by the
   <title>Drivers Requiring Firmware</title>
 <para>
 
+<!-- XXX: actually, we do! -->
+
 The installation system currently does not support retrieving firmware.
 This means that any network cards that use a driver that requires firmware
 to be loaded, is not supported by default.
@@ -124,6 +126,8 @@ the reboot at the end of the installation.
   <title>Wireless Network Cards</title>
 <para>
 
+<!-- XXX: the situation is now much much better -->
+
 Wireless NICs are in general supported as well, with one big proviso.
 A lot of wireless adapters require drivers that are either non-free or have
 not been accepted into the official Linux kernel. These NICs can generally
diff --git a/manual/en/hardware/supported-peripherals.xml b/manual/en/hardware/supported-peripherals.xml
index 41a2810..7a99f80 100644
--- a/manual/en/hardware/supported-peripherals.xml
+++ b/manual/en/hardware/supported-peripherals.xml
@@ -107,6 +107,7 @@ is an important market.
 </para>
 </sect2>
 
+<!-- XXX: mention firmware -->
 
   <sect2 arch="x86"><title>Windows-specific Hardware</title>
 <para>
diff --git a/manual/en/howto/installation-howto.xml b/manual/en/howto/installation-howto.xml
index 2a8133d..c342526 100644
--- a/manual/en/howto/installation-howto.xml
+++ b/manual/en/howto/installation-howto.xml
@@ -177,6 +177,7 @@ The files in <filename>netboot/</filename> can be used to netboot &d-i;.
 
 </para><para arch="x86">
 
+<!-- XXX: mention di-netboot-assistant -->
 The easiest thing to set up is probably PXE netbooting. Untar the
 file <filename>netboot/pxeboot.tar.gz</filename> into
 <filename>/var/lib/tftpboot</filename> or
@@ -292,6 +293,7 @@ See <xref linkend="pkgsel"/> for additional information about this step.
 Partitioning is followed by setting up user accounts. By default you will
 need to provide a password for the <quote>root</quote> (administrator)
 account and information necessary to create one regular user account.
+<!-- XXX: sudo is also possible -->
 
 </para><para>
 
diff --git a/manual/en/install-methods/boot-drive-files.xml b/manual/en/install-methods/boot-drive-files.xml
index 22f9b3a..5538835 100644
--- a/manual/en/install-methods/boot-drive-files.xml
+++ b/manual/en/install-methods/boot-drive-files.xml
@@ -18,6 +18,8 @@ unreliable floppy disks.
 
 </para><para arch="x86">
 
+<!-- XXX: it can when using win32-loader -->
+
 The installer cannot boot from files on an NTFS file system.
 
 </para><para arch="powerpc">
diff --git a/manual/en/install-methods/install-tftp.xml b/manual/en/install-methods/install-tftp.xml
index 8e96d48..a09bd35 100644
--- a/manual/en/install-methods/install-tftp.xml
+++ b/manual/en/install-methods/install-tftp.xml
@@ -11,6 +11,8 @@ intend to boot the installation system from another machine, the
 boot files will need to be placed in specific locations on that machine,
 and the machine configured to support booting of your specific machine.
 
+<!-- XXX: mention di-netboot-assistant -->
+
 </para><para>
 
 You need to setup a TFTP server, and for many machines a DHCP 
diff --git a/manual/en/install-methods/official-cdrom.xml b/manual/en/install-methods/official-cdrom.xml
index 3b8c449..dbc9035 100644
--- a/manual/en/install-methods/official-cdrom.xml
+++ b/manual/en/install-methods/official-cdrom.xml
@@ -42,6 +42,8 @@ are identical. So when archive file paths are given below for
 particular files you need for booting, look for those files in the
 same directories and subdirectories on your CD.
 
+<!-- XXX: mention win32-loader? -->
+
 </para><para>
 
 Once the installer is booted, it will be able to obtain all the other
diff --git a/manual/en/partitioning/device-names.xml b/manual/en/partitioning/device-names.xml
index 5f3b3c1..9bb76f1 100644
--- a/manual/en/partitioning/device-names.xml
+++ b/manual/en/partitioning/device-names.xml
@@ -6,6 +6,8 @@
  <title>Device Names in Linux</title>
 <para>
 
+<!-- XXX: looks a lot like what's in appendix/files.xml -->
+
 Linux disks and partition names may be different from other operating
 systems.  You need to know the names that Linux uses when you create
 and mount partitions. Here's the basic naming scheme:
diff --git a/manual/en/preparing/bios-setup/i386.xml b/manual/en/preparing/bios-setup/i386.xml
index f1c6eb1..2004e15 100644
--- a/manual/en/preparing/bios-setup/i386.xml
+++ b/manual/en/preparing/bios-setup/i386.xml
@@ -109,6 +109,8 @@ try using a shareware/freeware program.  Try looking in
 
   <sect2 arch="x86" id="boot-dev-select"><title>Boot Device Selection</title>
 
+<!-- XXX: mention that some BIOS support selecting boot device on-the-fly, e.g by pressing F12 -->
+
 <para>
 
 Many BIOS set-up menus allow you to select the devices that will be
diff --git a/manual/en/preparing/install-overview.xml b/manual/en/preparing/install-overview.xml
index 82bf857..098e33b 100644
--- a/manual/en/preparing/install-overview.xml
+++ b/manual/en/preparing/install-overview.xml
@@ -36,6 +36,8 @@ designed to re-install over an existing system.
 Here's a road map for the steps you will take during the installation
 process.
 
+<!-- XXX: update wrt. floppy issue; mention firmware -->
+
 </para>
 
 <orderedlist>
diff --git a/manual/en/preparing/needed-info.xml b/manual/en/preparing/needed-info.xml
index 04574e7..79eeca0 100644
--- a/manual/en/preparing/needed-info.xml
+++ b/manual/en/preparing/needed-info.xml
@@ -227,6 +227,7 @@ networking and e-mail.
   <entry>Partitions where other operating systems are installed.</entry>
 </row>
 
+<!-- XXX: X does ask all these informations these days -->
 <row arch="not-s390">
   <entry morerows="5">Monitor</entry>
   <entry>Model and manufacturer.</entry>
@@ -355,6 +356,9 @@ If your computer is connected to a network 24 hours a day (i.e., an
 Ethernet or equivalent connection &mdash; not a PPP connection), you
 should ask your network's system administrator for this information.
 
+<!-- XXX: most network now have a DHCP server, that should probably be
+emphasized -->
+
 <itemizedlist>
 <listitem><para>
 
diff --git a/manual/en/preparing/non-debian-partitioning.xml b/manual/en/preparing/non-debian-partitioning.xml
index 881ab59..f4f50f4 100644
--- a/manual/en/preparing/non-debian-partitioning.xml
+++ b/manual/en/preparing/non-debian-partitioning.xml
@@ -45,6 +45,8 @@ root.
 
 </para><para>
 
+<!-- XXX: parted should probably be mentioned here -->
+
 You can find information about your current partition setup by using
 a partitioning tool for your current operating system<phrase
 arch="x86">, such as fdisk or PartitionMagic</phrase><phrase
diff --git a/manual/en/preparing/nondeb-part/x86.xml b/manual/en/preparing/nondeb-part/x86.xml
index edc98ec..4765880 100644
--- a/manual/en/preparing/nondeb-part/x86.xml
+++ b/manual/en/preparing/nondeb-part/x86.xml
@@ -28,6 +28,8 @@ partition.
    <title>Lossless Repartitioning When Starting From DOS, Win-32 or OS/2
    </title>
 
+<!-- XXX: should be updated to remove ancient OS and verify coherence -->
+
 <para>
 
 One of the most common installations is onto a system that already
diff --git a/manual/en/using-d-i/using-d-i.xml b/manual/en/using-d-i/using-d-i.xml
index 3936c80..ab93acd 100644
--- a/manual/en/using-d-i/using-d-i.xml
+++ b/manual/en/using-d-i/using-d-i.xml
@@ -368,6 +368,7 @@ hard disk, or other media when trouble is encountered, in order to accurately
 report installer software problems to Debian developers later.
 
 </para></listitem>
+<!-- XXX: missing: flash-kernel, network-console, rescue, <suite>-support -->
 </varlistentry>
 
 </variablelist>
diff --git a/manual/en/welcome/welcome.xml b/manual/en/welcome/welcome.xml
index ee3a90c..d22cb51 100644
--- a/manual/en/welcome/welcome.xml
+++ b/manual/en/welcome/welcome.xml
@@ -15,6 +15,7 @@ the next chapter.
 &what-is-linux.xml;
 &what-is-debian-linux.xml;
 &what-is-debian-hurd.xml;
+<!-- XXX: what is debian GNU/kFreeBSD? -->
 &getting-newest-inst.xml;
 &getting-newest-doc.xml;
 &doc-organization.xml;
diff --git a/manual/en/welcome/what-is-linux.xml b/manual/en/welcome/what-is-linux.xml
index 374266d..a3e95d2 100644
--- a/manual/en/welcome/what-is-linux.xml
+++ b/manual/en/welcome/what-is-linux.xml
@@ -69,7 +69,7 @@ Linus Torvalds continues to coordinate the work of several hundred
 developers with the help of a few trusty deputies.  An excellent
 weekly summary of discussions on the
 <userinput>linux-kernel</userinput> mailing list is
-<ulink url="&url-kernel-traffic;">Kernel Traffic</ulink>.
+<ulink url="&url-kernel-traffic;">Kernel Traffic</ulink>. <!-- XXX: Kernel Traffic is dead. replace with LWN -->
 More information about the <userinput>linux-kernel</userinput> mailing
 list can be found on the
 <ulink url="&url-linux-kernel-list-faq;">linux-kernel mailing list FAQ</ulink>.

Attachment: signature.asc
Description: Digital signature


Reply to: