Date: Fri, 3 Oct 2003 16:48:04 +0200 (CEST) From: mark@remotelab.org To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/57541: Some suggestions for the Basics chapter of the Handbook Message-ID: <200310031448.h93Em4ms000368@einstein.lab> Resent-Message-ID: <200310031450.h93EoHwB046275@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 57541
>Category: docs
>Synopsis: Some suggestions for the Basics chapter of the Handbook
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: change-request
>Submitter-Id: current-users
>Arrival-Date: Fri Oct 03 07:50:17 PDT 2003
>Closed-Date:
>Last-Modified:
>Originator: Marco T.
>Release: FreeBSD 4.9-PRERELEASE i386
>Organization:
>Environment:
System: FreeBSD einstein.lab 4.9-PRERELEASE FreeBSD 4.9-PRERELEASE #0: Sun Sep 28 19:14:04 CEST 2003 root@einstein.lab:/usr/obj/usr/src/sys/EINSTEIN i386
>Description:
-add new item in Synopsis;
-correct one command prompt;
-tags,images and links adjustment (install --> basics);
-adapt two sentence into new context of basics chapter;
Some files in the handbook/install directory should be removed:
disk-layout.kil
example-dir1.dot
example-dir2.dot
example-dir3.dot
example-dir4.dot
example-dir5.dot
and some files in the doc/share/images/books/handbook/install directory should
be moved in a new doc/share/images/books/handbook/basics directory:
disk-layout.eps
example-dir1.eps
example-dir2.eps
example-dir3.eps
example-dir4.eps
example-dir5.eps
>How-To-Repeat:
>Fix:
--- all.diff begins here ---
--- chapter.sgml.old Fri Oct 3 16:34:35 2003
+++ chapter.sgml Fri Oct 3 16:34:15 2003
@@ -44,6 +44,9 @@
<para>The default &os; file system layout.</para>
</listitem>
<listitem>
+ <para>The &os; disk organization.</para>
+ </listitem>
+ <listitem>
<para>How to mount and unmount file systems.</para>
</listitem>
<listitem>
@@ -176,7 +179,7 @@
<para>You should see the <acronym>MOTD</acronym> or message of
the day followed by a command prompt (a <literal>#</literal>,
- <literal>$</literal>, or <literal>$</literal> character). This
+ <literal>$</literal>, or <literal>%</literal> character). This
indicates you have successfully logged into FreeBSD.</para>
</sect2>
@@ -894,7 +897,7 @@
<mediaobject>
<imageobject>
- <imagedata fileref="install/example-dir1" format="EPS">
+ <imagedata fileref="basics/example-dir1" format="EPS">
</imageobject>
<textobject>
@@ -914,7 +917,7 @@
<mediaobject>
<imageobject>
- <imagedata fileref="install/example-dir2" format="EPS">
+ <imagedata fileref="basics/example-dir2" format="EPS">
</imageobject>
<textobject>
@@ -942,7 +945,7 @@
<mediaobject>
<imageobject>
- <imagedata fileref="install/example-dir3" format="EPS">
+ <imagedata fileref="basics/example-dir3" format="EPS">
</imageobject>
<textobject>
@@ -968,7 +971,7 @@
<mediaobject>
<imageobject>
- <imagedata fileref="install/example-dir4" format="EPS">
+ <imagedata fileref="basics/example-dir4" format="EPS">
</imageobject>
<textobject>
@@ -994,7 +997,7 @@
<mediaobject>
<imageobject>
- <imagedata fileref="install/example-dir5" format="EPS">
+ <imagedata fileref="basics/example-dir5" format="EPS">
</imageobject>
<textobject>
@@ -1079,8 +1082,8 @@
</itemizedlist>
<para>Filesystems are contained in partitions. This does not have the
- same meaning as the earlier usage of the term partition in this
- chapter, because of FreeBSD's &unix; heritage. Each partition is
+ same meaning as the common usage of the term partition (for example, DOS
+ partition), because of FreeBSD's &unix; heritage. Each partition is
identified by a letter from <literal>a</literal> through to
<literal>h</literal>. Each partition can contain only one filesystem,
which means that filesystems are often described by either their
@@ -1150,7 +1153,7 @@
<para>Each partition-that-contains-a-filesystem is stored in what
FreeBSD calls a <firstterm>slice</firstterm>. Slice is FreeBSD's term
- for what were earlier called partitions, and again, this is because of
+ for what common call partitions, and again, this is because of
FreeBSD's &unix; background. Slices are numbered, starting at 1,
through to 4.</para>
@@ -1183,16 +1186,16 @@
starts with a code that indicates the type of disk, and then a number,
indicating which disk it is. Unlike slices, disk numbering starts at
0. Common codes that you will see are listed in
- <xref linkend="install-dev-codes">.</para>
+ <xref linkend="basics-dev-codes">.</para>
<para>When referring to a partition FreeBSD requires that you also name
the slice and disk that contains the partition, and when referring to
a slice you should also refer to the disk name. Do this by listing
the disk name, <literal>s</literal>, the slice number, and then the
partition letter. Examples are shown in
- <xref linkend="install-disk-slice-part">.</para>
+ <xref linkend="basics-disk-slice-part">.</para>
- <para><xref linkend="install-concept-disk-model"> shows a conceptual
+ <para><xref linkend="basics-concept-disk-model"> shows a conceptual
model of the disk layout that should help make things clearer.</para>
<para>In order to install FreeBSD you must first configure the disk
@@ -1200,7 +1203,7 @@
FreeBSD, and then create a filesystem (or swap space) in each
partition, and decide where that filesystem will be mounted.</para>
- <table frame="none" id="install-dev-codes">
+ <table frame="none" id="basics-dev-codes">
<title>Disk Device Codes</title>
<tgroup cols="2">
@@ -1249,7 +1252,7 @@
</tgroup>
</table>
- <example id="install-disk-slice-part">
+ <example id="basics-disk-slice-part">
<title>Sample Disk, Slice, and Partition Names</title>
<informaltable frame="none">
@@ -1286,7 +1289,7 @@
</informaltable>
</example>
- <example id="install-concept-disk-model">
+ <example id="basics-concept-disk-model">
<title>Conceptual Model of a Disk</title>
<para>This diagram shows FreeBSD's view of the first IDE disk attached
@@ -1304,7 +1307,7 @@
<mediaobject>
<imageobject>
- <imagedata fileref="install/disk-layout" format="EPS">
+ <imagedata fileref="basics/disk-layout" format="EPS">
</imageobject>
<textobject>
--- Makefile.old Fri Oct 3 16:34:58 2003
+++ Makefile Fri Oct 3 16:34:42 2003
@@ -39,6 +39,12 @@
IMAGES_EN = advanced-networking/isdn-bus.eps
IMAGES_EN+= advanced-networking/isdn-twisted-pair.eps
IMAGES_EN+= advanced-networking/natd.eps
+IMAGES_EN+= basics/disk-layout.eps
+IMAGES_EN+= basics/example-dir1.eps
+IMAGES_EN+= basics/example-dir2.eps
+IMAGES_EN+= basics/example-dir3.eps
+IMAGES_EN+= basics/example-dir4.eps
+IMAGES_EN+= basics/example-dir5.eps
IMAGES_EN+= install/userconfig.scr
IMAGES_EN+= install/userconfig2.scr
IMAGES_EN+= install/hdwrconf.scr
@@ -96,14 +102,7 @@
IMAGES_EN+= install/adduser2.scr
IMAGES_EN+= install/adduser3.scr
IMAGES_EN+= install/mainexit.scr
-IMAGES_EN+= install/disk-layout.eps
IMAGES_EN+= install/edit-inetd-conf.scr
-
-IMAGES_EN+= install/example-dir1.eps
-IMAGES_EN+= install/example-dir2.eps
-IMAGES_EN+= install/example-dir3.eps
-IMAGES_EN+= install/example-dir4.eps
-IMAGES_EN+= install/example-dir5.eps
IMAGES_EN+= security/ipsec-network.pic
IMAGES_EN+= security/ipsec-crypt-pkt.pic
IMAGES_EN+= security/ipsec-encap-pkt.pic
--- all.diff ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200310031448.h93Em4ms000368>