Bug 35823

Summary: [PATCH] Little Restructuring of the Developers Handbook
Product: Documentation Reporter: Hiten Pandya <hiten>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Hiten Pandya 2002-03-12 16:50:01 UTC
	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>

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>
How-To-Repeat: 
	Visit the Dev. Handbook, and look at the currently messed
	structure of the Filesystems and stuff. (no offense) :)
Comment 1 Hiten Pandya 2002-03-12 21:37:43 UTC
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>
Comment 2 Murray Stokely freebsd_committer freebsd_triage 2003-04-07 12:58:04 UTC
State Changed
From-To: open->closed

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.