From hitenp@hpdi.ath.cx  Tue Mar 12 08:47:14 2002
Return-Path: <hitenp@hpdi.ath.cx>
Received: from hpdi.ath.cx (pc2-nthf5-0-cust237.not.cable.ntl.com [80.4.35.237])
	by hub.freebsd.org (Postfix) with ESMTP id 7636C37C179
	for <FreeBSD-gnats-submit@freebsd.org>; Tue, 12 Mar 2002 08:45:19 -0800 (PST)
Received: (from hitenp@hpdi.ath.cx)
	by hpdi.ath.cx (8.11.6/8.11.6) id g2CGgGL00829;
	Tue, 12 Mar 2002 16:42:16 GMT
	(envelope-from hitenp@hpdi.ath.cx)
Message-Id: <200203121642.g2CGgGL00829@hpdi.ath.cx>
Date: Tue, 12 Mar 2002 16:42:16 GMT
From: Hiten Pandya <hiten@uk.FreeBSD.org>
Reply-To: Hiten Pandya <hiten@uk.FreeBSD.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [PATCH] Little Restructuring of the Developers Handbook
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         35823
>Category:       docs
>Synopsis:       [PATCH] Little Restructuring of the Developers Handbook
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          update
>Submitter-Id:   current-users
>Arrival-Date:   Tue Mar 12 08:50:01 PST 2002
>Closed-Date:    Mon Apr 07 04:59:46 PDT 2003
>Last-Modified:  Mon Apr 07 04:59:46 PDT 2003
>Originator:     Hiten Pandya
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD hpdi.ath.cx 5.0-CURRENT FreeBSD 5.0-CURRENT #1: Tue Mar 12 14:30:20 GMT 2002 hitenp@hpdi.ath.cx:/c1/obj/data/dev/src/sys/CURRENT5 i386

>Description:

	Currently, the Dev. Handbook is using the UFS chapter for having
	all the non-UFS things, and it also looks a bit un-organised.

	The patch I am submitting will resolve that issue by re-organising
	the UFS chapter, into a <part> called "Filesystem & I/O Services".

	This part will contain the following chapters:

		- Overview of the I/O System (namei, disklabels...)
		- The Virtual Filesystem Interface (vnodes, vnops...)
		- Local Filesystems (FFS, UFS, MFS, Ext2FS...)
		- Network Filesystems (AFS, NFS, SANs...)
		- Special Filesystems (PortalFS, UnionFS, ProcFS...)
		- Journaled (Log-based) Filesystems (JFS, LFS...)
	
	As of now, none of the above have been written up, but this
	patch is the first in the series, as it will help me to correctly
	place the content I will write up for the individual chapters
	named above.

	If you need more information, regarding this PR and the patch
	supplied, please do not hesitate to contact me.

	Thanks,
	Regards,

	  -- Hiten Pandya
	  -- <hiten@uk.FreeBSD.org>
	  
>How-To-Repeat:

	Visit the Dev. Handbook, and look at the currently messed
	structure of the Filesystems and stuff. (no offense) :)
	
>Fix:

	Please apply this patch (or comment) to:
		doc/en_US.ISO8859-1/books/developers-handbook/book.sgml
	
--- book.sgml	2002/03/12 16:13:16	1.1
+++ book.sgml	2002/03/12 16:20:42
@@ -97,7 +97,11 @@
     &chap.vm;
     &chap.dma;
     &chap.kerneldebug;
+  </part>
 
+  <part id="fsio">
+    <title>Filesystems & I/O Services</title>
+    
     <chapter id="ufs">
       <title>* UFS</title>
 
@@ -113,6 +117,7 @@
       <para>AFS, NFS, SANs, etc.</para>
 
     </chapter>
+  </part>
 
     <chapter id="syscons">
       <title>* Syscons</title>
>Release-Note:
>Audit-Trail:

From: Hiten Pandya <hiten@uk.FreeBSD.org>
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/35823 (update patch)
Date: Tue, 12 Mar 2002 21:37:43 +0000

 Oops, I am sorry about this, I forgot to diff my last change
 to the book.sgml file, so I am submitting the updated patch.
 
 Thanks,
 Regards,
 
   -- Hiten Pandya
   -- <hiten@uk.FreeBSD.org>
   
 --- book.sgml	2002/03/12 16:13:16	1.1
 +++ book.sgml	2002/03/12 21:28:33
 @@ -97,7 +97,11 @@
      &chap.vm;
      &chap.dma;
      &chap.kerneldebug;
 +  </part>
  
 +  <part id="fsio">
 +    <title>Filesystems & I/O Services</title>
 +    
      <chapter id="ufs">
        <title>* UFS</title>
  
 @@ -113,6 +117,7 @@
        <para>AFS, NFS, SANs, etc.</para>
  
      </chapter>
 +  </part>
  
      <chapter id="syscons">
        <title>* Syscons</title>
 @@ -132,7 +137,6 @@
        </sect1>
  
      </chapter>
 -  </part>
    
    <part id="devicedrivers">
      <title>Device Drivers</title>
State-Changed-From-To: open->closed 
State-Changed-By: murray 
State-Changed-When: Mon Apr 7 04:58:04 PDT 2003 
State-Changed-Why:  
Hi Hiten, this looks OK but lets just wait until we have some actual 
content to contribute.  Reorganizing the stub chapters and sections 
won't really gain us anything as long as they are still just 
place-holders.  Assuming that all of these chapters were filled in, 
then yes, I would like to see your reorg here. 


http://www.freebsd.org/cgi/query-pr.cgi?pr=35823 
>Unformatted:
