Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 1 Dec 2002 04:46:33 +0200
From:      Giorgos Keramidas <keramida@freebsd.org>
To:        freebsd-doc@freebsd.org
Subject:   Notes about devfs in the docs.
Message-ID:  <20021201024633.GA3728@gothmog.gr>

next in thread | raw e-mail | index | archive | help
Does the following look like a bad idea to anyone?  I just want to
make sure that users of 5.0-RELEASE will see a note stating that
MAKEDEV is not necessary with DEVFS, every time MAKEDEV is mentioned
in the docs.

This is arguably far from the best way to solve the (now default)
DEVFS vs. non-DEVFS systems problem, but it's a start.  Make sure you
Cc: me too, if you have any comments, ideas or suggestions.  Note that
this doesn't cover all the docs, since there are still references to
MAKEDEV in the following files that haven't reviewed:

    ./books/handbook/advanced-networking/chapter.sgml
    ./books/handbook/advanced-networking/chapter.sgml.orig
    ./books/handbook/advanced-networking/.#chapter.sgml.1.175
    ./books/handbook/backups/chapter.sgml
    ./books/handbook/basics/chapter.sgml
    ./books/handbook/config/chapter.sgml
    ./books/handbook/cutting-edge/chapter.sgml
    ./books/handbook/disks/chapter.sgml
    ./books/handbook/kernelconfig/chapter.sgml
    ./books/handbook/x11/chapter.sgml
    ./books/handbook/multimedia/chapter.sgml
    ./books/handbook/ppp-and-slip/chapter.sgml
    ./books/handbook/printing/chapter.sgml
    ./books/handbook/serialcomms/chapter.sgml

%%%
Index: articles/console-server/article.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/articles/console-server/article.sgml,v
retrieving revision 1.8
diff -u -r1.8 article.sgml
--- articles/console-server/article.sgml	11 Jul 2002 19:07:48 -0000	1.8
+++ articles/console-server/article.sgml	23 Nov 2002 19:45:22 -0000
@@ -288,6 +288,10 @@
 
     <h4>Making The Devices</h4>
 
+    <p>(NOTE: In FreeBSD 5.x, the <samp>MAKEDEV</samp> run is not
+      required if you are running a kernel that uses
+      <samp>DEVFS</samp>.)</p>
+
     <p>You will need to make the device nodes for the Stallion card
       (which are not made by default).  A new version of
       <samp>/dev/MAKEDEV</samp> with Stallion support will have been
Index: articles/diskless-x/article.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/articles/diskless-x/article.sgml,v
retrieving revision 1.9
diff -u -r1.9 article.sgml
--- articles/diskless-x/article.sgml	27 Mar 2002 01:16:43 -0000	1.9
+++ articles/diskless-x/article.sgml	23 Nov 2002 19:46:36 -0000
@@ -304,7 +304,9 @@
 -r-xr-xr-x  1 root  wheel    1992 Jun 10  1995 ./dev/MAKEDEV.local
 -r-xr-xr-x  1 root  wheel   24419 Jun 10  1995 ./dev/MAKEDEV</screen>
     
-    <para>Do not forget to run <command>MAKEDEV all</command> in the
+    <para>If you are not using <literal>DEVFS</literal> (which is the default
+      in FreeBSD 5.x), you should make sure that you
+      do not forget to run <command>MAKEDEV all</command> in the
       <filename>dev</filename> directory.</para>
 
     <para>My <filename>/etc/rc</filename> for <hostid>altair</hostid>
Index: articles/serial-uart/article.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/articles/serial-uart/article.sgml,v
retrieving revision 1.6
diff -u -r1.6 article.sgml
--- articles/serial-uart/article.sgml	15 Feb 2002 01:05:58 -0000	1.6
+++ articles/serial-uart/article.sgml	30 Nov 2002 11:17:33 -0000
@@ -2137,7 +2137,12 @@
 	    <para>Next, appropriate entries in
 	      <filename>/dev</filename> for the devices must be made
 	      using the <filename>/dev/MAKEDEV</filename>
-	      script. After becoming root:</para>
+	      script.  This step can be ommitted if you are running
+	      FreeBSD 5.x with a kernel that has <literal>DEVFS</literal>
+	      support compiled in.</para>
+	      
+	    <para>If you do need to create the <filename>/dev</filename>
+	      entries, run the following as <username>root</username>:</para>
 	      
 	    <screen>&prompt.root; <userinput>cd /dev</userinput>
 &prompt.root; <userinput>./MAKEDEV tty1</userinput>
@@ -2310,7 +2315,10 @@
 	  
 	  <step>
 	    <para>Make the device nodes by typing (the following
-	      example assumes an 8-port board):</para>
+	      example assumes an 8-port board)<footnote>
+	        <para>You can ommit this part if you are running FreeBSD 5.x
+		  with <literal>DEVFS</literal>.</para>
+	      </footnote>:</para>
 		  
 	    <screen>&prompt.root; <userinput>cd /dev</userinput>
 &prompt.root; <userinput>for i in 0 1 2 3 4 5 6 7;do ./MAKEDEV cuac$i ttyc$i;done</userinput></screen>
@@ -2396,8 +2404,13 @@
       <para>After adding the configuration entry, rebuild and
 	install your new kernel.</para>
      
+      <note>
+        <para>The following step, is not necessary if you are using
+          DEVFS in FreeBSD 5.<replaceable>X</replaceable>.</para>
+      </note>
+
       <para>After rebooting with the new kernel, you need to make the
-	device nodes in /dev. The <filename>MAKEDEV</filename> script
+	device nodes in <filename>/dev</filename>.  The <filename>MAKEDEV</filename> script
 	will take care of this for you.  Count how many total ports
 	you have and type:</para>
      
Index: books/developers-handbook/driverbasics/chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/developers-handbook/driverbasics/chapter.sgml,v
retrieving revision 1.20
diff -u -r1.20 chapter.sgml
--- books/developers-handbook/driverbasics/chapter.sgml	27 Aug 2002 16:58:05 -0000	1.20
+++ books/developers-handbook/driverbasics/chapter.sgml	30 Nov 2002 11:20:20 -0000
@@ -28,8 +28,10 @@
     <para>Most devices in a Unix-like operating system are accessed
       through device-nodes, sometimes also called special files.
       These files are usually located under the directory
-      <filename>/dev</filename> in the filesystem hierarchy.  Until
-      devfs is fully integrated into FreeBSD, each device node must be
+      <filename>/dev</filename> in the filesystem hierarchy.
+      In releases of FreeBSD older than 5.0-RELEASE, where
+      <literal>DEVFS</literal> support is not integrated into FreeBSD,
+      each device node must be
       created statically and independent of the existence of the
       associated device driver.  Most device nodes on the system are
       created by running <command>MAKEDEV</command>.</para>
Index: books/faq/book.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/faq/book.sgml,v
retrieving revision 1.497
diff -u -r1.497 book.sgml
--- books/faq/book.sgml	30 Nov 2002 12:17:03 -0000	1.497
+++ books/faq/book.sgml	30 Nov 2002 12:23:40 -0000
@@ -23,7 +23,7 @@
 
     <corpauthor>The FreeBSD Documentation Project</corpauthor>
 
-    <pubdate>$FreeBSD: doc/en_US.ISO8859-1/books/faq/book.sgml,v 1.497 2002/11/30 12:17:03 keramida Exp $</pubdate>
+    <pubdate>$FreeBSD: doc/en_US.ISO8859-1/books/faq/book.sgml,v 1.496 2002/11/30 06:00:47 jesusr Exp $</pubdate>
 
     <copyright>
       <year>1995</year>
@@ -2458,6 +2458,12 @@
               <screen>&prompt.root; <userinput>cd /dev</userinput>
 &prompt.root; <userinput>./MAKEDEV kbd0 kbd1</userinput></screen>
 
+              <note>
+	        <para>You can ommit this step if you are running FreeBSD
+	          5.0-RELEASE or newer with <literal>DEVFS</literal> enabled,
+	          since the proper device nodes will be created automatically
+	          under <filename>/dev</filename>.</para>
+	      </note>
             </step>
 
             <step>
@@ -2586,7 +2592,14 @@
           <screen>&prompt.root; <userinput>cd /dev; sh MAKEDEV psm0</userinput></screen>
 
           <para>when logged in as <username>root</username>.</para>
-        </answer>
+
+          <note>
+	    <para>You can ommit this step if you are running FreeBSD
+	      5.0-RELEASE or newer with <literal>DEVFS</literal> enabled,
+	      since the proper device nodes will be created automatically
+	      under <filename>/dev</filename>.</para>
+	  </note>
+	</answer>
       </qandaentry>
 
       <qandaentry>
@@ -2714,6 +2727,13 @@
 
               <screen>&prompt.root; <userinput>cd /dev</userinput>
 &prompt.root; <userinput>./MAKEDEV ums0</userinput></screen>
+
+              <note>
+	        <para>You can ommit this step if you are running FreeBSD
+	          5.0-RELEASE or newer with <literal>DEVFS</literal> enabled,
+	          since the proper device nodes will be created automatically
+	          under <filename>/dev</filename>.</para>
+	      </note>
             </step>
 
             <step>
@@ -3944,6 +3964,13 @@
           <screen>&prompt.root; <userinput>cd /dev</userinput>
 &prompt.root; <userinput>./MAKEDEV snd1</userinput></screen>
 
+          <note>
+	    <para>You can ommit this step if you are running FreeBSD
+	      5.0-RELEASE or newer with <literal>DEVFS</literal> enabled,
+	      since the proper device nodes will be created automatically
+	      under <filename>/dev</filename>.</para>
+	  </note>
+
           <para>This situation does not arise in FreeBSD 4.X as a lot
             of work has been done to make it more
             <emphasis>PnP-centric</emphasis> and the
@@ -5650,11 +5677,17 @@
           partitions. For example, if you have an <quote>E</quote>
           partition as the second DOS partition on the second SCSI drive,
           you need to create the special files for <quote>slice 5</quote>
-          in /dev, then mount /dev/da1s5:</para>
+          in <filename>/dev</filename>, then mount <devicename>/dev/da1s5</devicename>:</para>
 
         <screen>&prompt.root; <userinput>cd /dev</userinput>
 &prompt.root; <userinput>sh MAKEDEV da1s5</userinput>
 &prompt.root; <userinput>mount -t msdos /dev/da1s5 /dos/e</userinput></screen>
+
+        <note>
+	  <para>You can ommit this step if you are running FreeBSD
+	    5.0-RELEASE or newer with <literal>DEVFS</literal>
+	    enabled.</para>
+	</note>
         </answer>
       </qandaentry>
 
@@ -6894,7 +6927,7 @@
           <screen>&prompt.root; <userinput>cd /cdrom/bin</userinput>
 &prompt.root; <userinput>./install.sh</userinput></screen>
 
-          <para>Alternately, you can remove all <literal>MAKE_KERBEROS</literal>
+          <para>Alternately, you can remove all "MAKE_KERBEROS"
             options from <filename>/etc/make.conf</filename> and rebuild
             world.</para>
         </answer>
@@ -6966,6 +6999,12 @@
 
           <screen>&prompt.root; <userinput>cd /dev</userinput>
 &prompt.root; <userinput>sh MAKEDEV snd0</userinput></screen>
+
+          <note>
+	    <para>You can ommit this step if you are running FreeBSD
+	      5.0-RELEASE or newer with <literal>DEVFS</literal>
+	      enabled.</para>
+	  </note>
         </answer>
       </qandaentry>
 
%%%


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20021201024633.GA3728>