+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">\r
+\r
+<article>\r
+\r
+<!-- Header -->\r
+\r
+ <artheader>\r
+ <title>Free Software Development HOWTO</title>\r
+\r
+ <author>\r
+ <firstname>Benjamin</firstname>\r
+ <othername>Mako</othername>\r
+ <surnamen>Hill</surname>\r
+ <affiliation>\r
+ <address>\r
+ <email>mako@debian.org</email>\r
+ </address>\r
+ </affiliation>\r
+ </author>\r
+\r
+ <revhistory>\r
+ <revision>\r
+ <revnumber>v0.01</revnumber>\r
+ <date>1 January 2001</date>\r
+ <authorinitials>bch</authorinitials>\r
+ <revremark>\r
+ Initial Release\r
+ </revremark>\r
+ </revision>\r
+ </revhistory>\r
+\r
+ <abstract>\r
+ <indexterm>\r
+ <primary>fswd</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ This HOWTO is designed for people with experience in programming\r
+ and some skills in managing a software project but who are new to\r
+ the world of Free Software. This document is meant to act as a\r
+ guide to the non-technical aspects of programming and is meant as\r
+ a crash course in the people skills that can make or break a free\r
+ software project.\r
+ </para>\r
+ </abstract>\r
+\r
+ </artheader>\r
+\r
+<!-- Section1: intro -->\r
+\r
+ <sect1 id="intro">\r
+ <title>Introduction</title>\r
+\r
+ <indexterm>\r
+ <primary>fswd!introduction</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ For various reasons this brand new release is codenamed the\r
+ <emphasis>release</emphasis> release.\r
+ </para>\r
+\r
+ <para>\r
+ New code names will appear as per industry standard\r
+ guidelines to emphasize the state-of-the-art-ness of this\r
+ document.\r
+ </para>\r
+\r
+ <para>\r
+ This document was written when I read a feedback asking for a\r
+ template to fill in to make new HOWTOs. This template was\r
+ initially made by extracting the skeletal structure of the Multi\r
+ Disk HOWTO which is a rather large HOWTO. It then went through\r
+ extensive editing.\r
+ </para>\r
+\r
+ <para>\r
+ Stating the background is a simple way to getting started\r
+ writing the intro.\r
+ </para>\r
+\r
+ <para>\r
+ First of all we need a bit of legalese. Recent development\r
+ shows it is quite important.\r
+ </para>\r
+\r
+<!-- Section2: copyright -->\r
+\r
+ <sect2 id="copyright">\r
+ <title>Copyright Information</title>\r
+\r
+ <para>\r
+ This document is copyrighted (c) 2000 Stein Gjoen and is\r
+ distributed under the terms of the Linux Documentation Project\r
+ (LDP) license, stated below. <emphasis>Replace with your name,\r
+ or supply a new license, when you use this skeleton for a new\r
+ HOWTO.</emphasis>\r
+ </para>\r
+\r
+ <para>\r
+ Unless otherwise stated, Linux HOWTO documents are\r
+ copyrighted by their respective authors. Linux HOWTO documents may\r
+ be reproduced and distributed in whole or in part, in any medium\r
+ physical or electronic, as long as this copyright notice is\r
+ retained on all copies. Commercial redistribution is allowed and\r
+ encouraged; however, the author would like to be notified of any\r
+ such distributions.\r
+ </para>\r
+\r
+ <para>\r
+ All translations, derivative works, or aggregate works\r
+ incorporating any Linux HOWTO documents must be covered under this\r
+ copyright notice. That is, you may not produce a derivative work\r
+ from a HOWTO and impose additional restrictions on its\r
+ distribution. Exceptions to these rules may be granted under\r
+ certain conditions; please contact the Linux HOWTO coordinator at\r
+ the address given below.\r
+ </para>\r
+\r
+ <para>\r
+ In short, we wish to promote dissemination of this\r
+ information through as many channels as possible. However, we do\r
+ wish to retain copyright on the HOWTO documents, and would like to\r
+ be notified of any plans to redistribute the HOWTOs.\r
+ </para>\r
+\r
+ <para>\r
+ If you have any questions, please contact \r
+ <email>linux-howto@metalab.unc.edu</email>\r
+ </para>\r
+ </sect2>\r
+\r
+<!-- Section2: disclaimer -->\r
+\r
+ <sect2 id="disclaimer">\r
+ <title>Disclaimer</title>\r
+\r
+ <para>\r
+ No liability for the contents of this documents can be accepted.\r
+ Use the concepts, examples and other content at your own risk.\r
+ As this is a new edition of this document, there may be errors\r
+ and inaccuracies, that may of course be damaging to your system.\r
+ Proceed with caution, and although this is highly unlikely,\r
+ the author(s) do not take any responsibility for that.\r
+ </para>\r
+\r
+ <para>\r
+ All copyrights are held by their by their respective owners, unless\r
+ specifically noted otherwise. Use of a term in this document\r
+ should not be regarded as affecting the validity of any trademark\r
+ or service mark.\r
+ </para>\r
+\r
+ <para>\r
+ Naming of particular products or brands should not be seen \r
+ as endorsements.\r
+ </para>\r
+\r
+ <para>\r
+ You are strongly recommended to take a backup of your system \r
+ before major installation and backups at regular intervals.\r
+ </para>\r
+ </sect2>\r
+\r
+<!-- Section2: newversions-->\r
+\r
+ <sect2 id="newversions">\r
+ <title>New Versions</title>\r
+\r
+ <indexterm>\r
+ <primary>(your index root)!news on</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ This is where you make a summary of what is new. When a\r
+ HOWTO exceeds 20 pages it takes more than a casual read to find\r
+ the updates. This is where you help your readers with that,\r
+ alerting them to specific and important updates to the document.\r
+ </para>\r
+\r
+ <para>\r
+ This is the initial release.\r
+ </para>\r
+\r
+ <para>\r
+ Tell people where the document home page is so the very\r
+ newest release could be found in case of problems with the main\r
+ <ulink url="http://www.linuxdoc.org/">Linux Documentation\r
+ Project</ulink> homepage.\r
+ </para>\r
+\r
+ <para>\r
+ The following is a sample from the Multi Disk HOWTO:\r
+ </para>\r
+\r
+ <para>\r
+ The latest version number of this document can be \r
+ gleaned from my plan entry if you \r
+ <ulink url="http://www.cs.indiana.edu/finger/nox.nyx.net/sgjoen">\r
+ finger</ulink> my Nyx account.\r
+ </para>\r
+\r
+ <para>\r
+ <emphasis>If you have the capability, it would be nice to \r
+ make the HOWTO available in a number of formats.</emphasis>\r
+ </para>\r
+\r
+ <para>\r
+ The newest version of this HOWTO will always be made available on\r
+ my website, in a variety of formats:\r
+ </para>\r
+\r
+ <para>\r
+ <itemizedlist>\r
+ <listitem>\r
+ <para>\r
+ <ulink url="http://www.nyx.net/~sgjoen/disk.html">HTML</ulink>.\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink URL="http://www.nyx.net/~sgjoen/disk.txt">plain text</ulink>.\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink url="http://www.nyx.net/~sgjoen/disk-US.ps.gz">compressed \r
+ postscript (US letter format)</ulink>.\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink url="http://www.nyx.net/~sgjoen/disk.sgml">SGML source</ulink>.\r
+ </para>\r
+ </listitem>\r
+ </itemizedlist>\r
+ </para>\r
+\r
+ <para>\r
+ Note that paper sizes vary in the world, A4 and US letter differ \r
+ significantly. You might also wish to consider using the \r
+ <emphasis>universal format</emphasis> (8.27x11in; 210x279mm). \r
+ </para>\r
+ </sect2>\r
+\r
+<!-- Section2: credits -->\r
+\r
+ <sect2 id="credits">\r
+ <title>Credits</title>\r
+\r
+ <para>\r
+ <emphasis>It is always nice to acknowledge people who help you\r
+ with input; it is also regarded by many as important in the\r
+ Linux world new economy.</emphasis>\r
+ </para>\r
+\r
+ <para>\r
+ In this version I have the pleasure of acknowledging:\r
+ </para>\r
+\r
+ <para>\r
+ <email>name (at) site.org</email>\r
+ </para>\r
+\r
+ <para>\r
+ <emphasis>Please scramble the addresses so email harvesters\r
+ cannot get addresses from your HOWTO and then spam people. That\r
+ has happened in the past.</emphasis>\r
+ </para>\r
+\r
+ <para>\r
+ <emphasis>Somecompany</emphasis> is acknowledged for sending me\r
+ documentation on their gizmos as well as permission to quote from\r
+ the material. These quotes have been approved before appearing\r
+ here and will be clearly labeled.\r
+ </para>\r
+ </sect2>\r
+\r
+<!-- Section2: feedback -->\r
+\r
+ <sect2 id="feedback">\r
+ <title>Feedback</title>\r
+\r
+ <para>\r
+ Feedback is most certainly welcome for this document. Without\r
+ your submissions and input, this document wouldn't exist. Please\r
+ send your additions, comments and criticisms to the following\r
+ email address : <email>sgjoen@nyx.net</email>.\r
+ </para>\r
+ </sect2>\r
+\r
+<!-- Section2: translations -->\r
+\r
+ <sect2 id="translations">\r
+ <title>Translations</title>\r
+\r
+ <para>\r
+ Not everyone speaks English, pointers to translations are nice.\r
+ Also your translators tend to give very important inputs.\r
+ </para>\r
+\r
+ <para>\r
+ <itemizedlist>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink url="http://linuxdoc.org/">German Translation</ulink>\r
+ by <email>someone (at) somewhere.de</email>\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink url="http://linuxdoc.org/">French Translation</ulink>\r
+ by <email>someone (at) somewhere.fr</email>\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink url="http://linuxdoc.org/">Italian Translation</ulink>\r
+ by <email>someone (at) somewhere.it</email>\r
+ </para>\r
+ </listitem>\r
+ </itemizedlist>\r
+ </para>\r
+ </sect2>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: intro: END -->\r
+\r
+<!-- Section1: starting -->\r
+\r
+ <sect1 id="starting">\r
+ <title>Starting a Project</title>\r
+\r
+<!-- Section2: chooseproject-->\r
+\r
+ <sect2 id="chooseproject">\r
+ <title>Choosing a Project</title>\r
+ </sect2>\r
+\r
+<!-- Section2: chooselicense-->\r
+\r
+ <sect2 id="chooselicense">\r
+ <title>Deciding on a License</title>\r
+ </sect2>\r
+\r
+<!-- Section2: chooseversioning-->\r
+\r
+ <sect2 id="chooseversioning">\r
+ <title>Choosing a Method of Version Numbering</title>\r
+ </sect2>\r
+\r
+<!-- Section2: documentation-->\r
+\r
+ <sect2 id="documentation">\r
+ <title>Documentation</title>\r
+ </sect2>\r
+\r
+<!-- Section2: presentation -->\r
+\r
+ <sect2 id="presentation">\r
+ <title>Other Presentation Issues</title>\r
+ </sect2>\r
+\r
+<!-- Section2: futuredev -->\r
+\r
+ <sect2 id="futuredev">\r
+ <title>Nuturing Future Development</title>\r
+ </sect2>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: starting: END -->\r
+\r
+<!-- Section1: developers -->\r
+\r
+ <sect1 id="developers">\r
+ <title>Maintaining a Project: Interacting with Developers</title>\r
+\r
+<!-- Section2: delegation -->\r
+\r
+ <sect2 id="delegation">\r
+ <title>Delegating Work</title>\r
+ </sect2>\r
+\r
+<!-- Section2: branches -->\r
+\r
+ <sect2 id="branches">\r
+ <title>Stable and Development Branches</title>\r
+ </sect2>\r
+\r
+<!-- Section2: freezing -->\r
+\r
+ <sect2 id="freezing">\r
+ <title>Freezing</title>\r
+ </sect2>\r
+\r
+<!-- Section2: codecram -->\r
+\r
+ <sect2 id="codecram">\r
+ <title>Avoiding the Code Cram Effect</title>\r
+ </sect2>\r
+\r
+<!-- Section2: patching -->\r
+\r
+ <sect2 id="patching">\r
+ <title>Accepting and Rejecting Patches</title>\r
+ </sect2>\r
+ </sect1>\r
+\r
+<!-- Section1: users -->\r
+\r
+ <sect1 id="users">\r
+ <title>Maintaining a Project: Interacting with Users</title>\r
+\r
+<!-- Section2: announcing -->\r
+\r
+ <sect2 id="announcing">\r
+ <title>Announcing Your Project</title>\r
+ </sect2>\r
+\r
+<!-- Section2: testing -->\r
+\r
+ <sect2 id="testing">\r
+ <title>Testing and Testers</title>\r
+ </sect2>\r
+</sect1>\r
+\r
+<!-- Section1: samples -->\r
+\r
+ <sect1 id="samples">\r
+ <title>Samples</title>\r
+\r
+ <para>\r
+ <emphasis>This section gives some simple SGML examples you could\r
+ use. Read the SGML source to see how it was done.</emphasis>\r
+ </para>\r
+\r
+ <para>\r
+ Further information and examples can be obtained from the publication\r
+ <ulink url="http://docbook.org/tdg/html/">DocBook: The Definitive \r
+ Guide</ulink>. Written by <emphasis>Norman Walsh</emphasis>\r
+ and <emphasis>Leonard Muellner</emphasis>; 1st Edition, October 1999.\r
+ </para>\r
+ \r
+<!-- Section2: lists -->\r
+\r
+ <sect2 id="lists">\r
+ <title>Lists</title>\r
+\r
+ <para>\r
+ <emphasis>Lists are used frequently, and are available in a number\r
+ of formats shown below.</emphasis>\r
+ </para>\r
+\r
+ <para>\r
+ A list in which each entry is marked with a bullet or other dingbat:\r
+ </para>\r
+\r
+ <para>\r
+ <itemizedlist>\r
+\r
+ <listitem>\r
+ <para>Apples</para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>Oranges</para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>Bananas</para>\r
+ </listitem>\r
+\r
+ </itemizedlist>\r
+ </para>\r
+\r
+ <para>\r
+ A list in which each entry is composed of a set of one or more\r
+ terms and an associated description:\r
+ </para>\r
+\r
+ <para>\r
+ <variablelist>\r
+\r
+ <varlistentry>\r
+ <term>Fruits</term>\r
+ <listitem>\r
+ <para>such as apples, oranges, and more.</para>\r
+ </listitem>\r
+ </varlistentry>\r
+\r
+ <varlistentry>\r
+ <term>Nuts</term>\r
+ <listitem>\r
+ <para>Don't eat too many; you are what you eat.</para>\r
+ </listitem>\r
+ </varlistentry>\r
+\r
+ <varlistentry>\r
+ <term>Vegetables</term>\r
+ <listitem>\r
+ <para>Potatos are spelled with care.</para>\r
+ </listitem>\r
+ </varlistentry>\r
+\r
+ </variablelist>\r
+ </para>\r
+\r
+ <para>\r
+ A list in which each entry is marked with a sequentially \r
+ incremented label:\r
+ </para>\r
+\r
+ <para>\r
+ <orderedlist>\r
+\r
+ <listitem>\r
+ <para>Step one</para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>Step two</para>\r
+ </listitem>\r
+\r
+ </orderedlist>\r
+ </para>\r
+ </sect2>\r
+\r
+<!-- Section2: links -->\r
+\r
+ <sect2 id="links">\r
+ <title>Links</title>\r
+\r
+ <para>\r
+ <emphasis>Links can be used within your documents to refer to\r
+ different sections and chapters or to refer to documents external\r
+ to yours.</emphasis>\r
+ </para>\r
+\r
+ <sect3 id="int-links">\r
+ <title>Internal links</title>\r
+\r
+ <para>\r
+ Click on the <xref LinkEnd="samples"> link to jump to the top of\r
+ this chapter. Note the anchor at the section tag.\r
+ </para>\r
+ </sect3>\r
+\r
+ <sect3 id="ext-links">\r
+ <title>External links</title>\r
+\r
+ <para>\r
+ Click on <ulink url="http://www.linuxdoc.org/">this</ulink> link\r
+ to jump to the LDP site. Note you can use http, ftp, news and\r
+ other protocols in the locator if required.\r
+ </para>\r
+ </sect3>\r
+\r
+ </sect2>\r
+\r
+<!-- Section2: images -->\r
+\r
+ <sect2 id="images">\r
+ <title>Images</title>\r
+\r
+ <para>\r
+ <emphasis>Avoid diagrams if possible as this cannot be rendered\r
+ in the ASCII outputs which are still needed by many around the\r
+ world.</emphasis>\r
+ </para>\r
+\r
+ <para>\r
+ <figure>\r
+ <title>Graphics Test Image</title>\r
+ <graphic FileRef="red.gif"></graphic>\r
+ </figure>\r
+ </para>\r
+\r
+ <para>\r
+ Here is another variation which allows for ALT text:\r
+ </para>\r
+\r
+ <para>\r
+ <mediaobject>\r
+\r
+ <imageobject>\r
+ <imagedata fileref="green.gif" format="gif">\r
+ </imageobject>\r
+\r
+ <textobject>\r
+ <phrase>\r
+ ALT text to be used: Green Ball\r
+ </phrase>\r
+ </textobject>\r
+\r
+ <caption>\r
+ <para>\r
+ Caption for the graphic goes here: This is a Green Ball.\r
+ </para>\r
+ </caption>\r
+ </mediaobject>\r
+ </para>\r
+ </sect2>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: samples: END -->\r
+\r
+\r
+<!-- Section1: structure -->\r
+\r
+ <sect1 id="structure">\r
+ <title>Structure</title>\r
+\r
+ <para>\r
+ <emphasis>A quick overview on how all parts fit together in the overall\r
+ structure. An example from the Multi Disk HOWTO is used.</emphasis>\r
+ </para>\r
+\r
+ <para>\r
+ As this type of document is supposed to be as much for learning as\r
+ a technical reference document I have rearranged the structure to\r
+ this end. For the designer of a system it is more useful to have\r
+ the information presented in terms of the goals of this exercise\r
+ than from the point of view of the logical layer structure of the\r
+ devices themselves. Nevertheless this document would not be\r
+ complete without such a layer structure the computer field is so\r
+ full of, so I will include it here as an introduction to how it\r
+ works.\r
+ </para>\r
+\r
+<!-- Section2: logical-struct -->\r
+\r
+ <sect2 id="logical-struct">\r
+ <title>Logical structure</title>\r
+\r
+ <indexterm>\r
+ <primary>disk!structure, I/O subsystem</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ This is based on how each layer access each other, traditionally\r
+ with the application on top and the physical layer on the bottom.\r
+ It is quite useful to show the interrelationship between each of\r
+ the layers used in controlling drives.\r
+\r
+ <screen>\r
+ ___________________________________________________________\r
+ |__ File structure ( /usr /tmp etc) __|\r
+ |__ File system (ext2fs, vfat etc) __|\r
+ |__ Volume management (AFS) __|\r
+ |__ RAID, concatenation (md) __|\r
+ |__ Device driver (SCSI, IDE etc) __|\r
+ |__ Controller (chip, card) __|\r
+ |__ Connection (cable, network) __|\r
+ |__ Drive (magnetic, optical etc) __|\r
+ -----------------------------------------------------------\r
+ </screen>\r
+ </para>\r
+\r
+ <para>\r
+ In the above diagram both volume management and RAID and\r
+ concatenation are optional layers. The 3 lower layers are in\r
+ hardware. All parts are discussed at length later on in this\r
+ document.\r
+ </para>\r
+ </sect2>\r
+\r
+<!-- Section2: doc-struct -->\r
+\r
+ <sect2 id="doc-struct">\r
+ <title>Document structure</title>\r
+\r
+ <para>\r
+ Most users start out with a given set of hardware and some plans\r
+ on what they wish to achieve and how big the system should be.\r
+ This is the point of view I will adopt in this document in\r
+ presenting the material, starting out with hardware, continuing\r
+ with design constraints before detailing the design strategy that\r
+ I have found to work well. I have used this both for my own\r
+ personal computer at home, a multi purpose server at work and\r
+ found it worked quite well. In addition my Japanese co-worker in\r
+ this project have applied the same strategy on a server in an\r
+ academic setting with similar success.\r
+ </para>\r
+\r
+ <para>\r
+ Finally at the end I have detailed some configuration tables for\r
+ use in your own design. If you have any comments regarding this\r
+ or notes from your own design work I would like to hear from you\r
+ so this document can be upgraded.\r
+ </para>\r
+ </sect2>\r
+\r
+<!-- Section2: reading-plan -->\r
+\r
+ <sect2 id="reading-plan">\r
+ <title>Reading plan</title>\r
+\r
+ <para>\r
+ <emphasis>As you go beyond 50 pages or so there will be a lot of\r
+ text that experts and even the experienced do not need to read.\r
+ Keeping in mind that we wish to care for all kinds of people in\r
+ the Linux world we might have to make a reading plan. Again,\r
+ an example follows from the Multi Disk HOWTO.</emphasis>\r
+ </para>\r
+\r
+ <para>\r
+ Although not the biggest HOWTO it is nevertheless rather big\r
+ already and I have been requested to make a reading plan to make\r
+ it possible to cut down on the volume.\r
+ </para>\r
+\r
+ <para>\r
+ <variablelist>\r
+\r
+ <varlistentry>\r
+ <term>Expert</term>\r
+ <listitem>\r
+ <para>\r
+ (aka the elite). If you are familiar with Linux as well as\r
+ disk drive technologies you will find most of what you need in\r
+ the appendices. Additionally you are recommended to read the\r
+ FAQ and the <XRef LinkEnd="bits-n-pieces">chapter.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+\r
+ <varlistentry>\r
+ <term>Experienced</term>\r
+ <listitem>\r
+ <para>\r
+ (aka Competent). If you are familiar with computers in\r
+ general you can go straight to the chapters on \r
+ <XRef LinkEnd="technologies"> and continue from there on.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+\r
+ <varlistentry>\r
+ <term>Newbie</term>\r
+ <listitem>\r
+ <para>\r
+ (mostly harmless). You just have to read the whole thing.\r
+ Sorry. In addition you are also recommended to read all the\r
+ other disk related HOWTOs.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+\r
+ </variablelist>\r
+ </para>\r
+ </sect2>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: structure: END -->\r
+\r
+\r
+<!-- Section1: technologies -->\r
+\r
+ <sect1 id="technologies">\r
+ <title>Technologies</title>\r
+\r
+ <indexterm>\r
+ <primary>(your index root)!technologies</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ <emphasis>Introduction of technology for the newbie with a few\r
+ references to detailed works. Remember that not everyone has\r
+ Internet access so you have to explain in sufficient details so\r
+ even the newbie can get by.</emphasis>\r
+ </para>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: technologies: END -->\r
+\r
+\r
+<!-- Section1: implement -->\r
+\r
+ <sect1 id="implement">\r
+ <title>Implementation</title>\r
+\r
+ <indexterm>\r
+ <primary>(your index root)!implementation</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ <emphasis>Now your readers should have a sufficient knowledge of\r
+ what this is about and now we come to the hands on of implementing\r
+ your clever scheme.</emphasis>\r
+ </para>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: implement: END -->\r
+\r
+\r
+<!-- Section1: maint -->\r
+\r
+ <sect1 id="maint">\r
+ <title>Maintenance</title>\r
+\r
+ <indexterm>\r
+ <primary>(your index root)!maintenance</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ <emphasis>Few systems and designs are maintenance free, here you\r
+ explain how to keep the system running.</emphasis>\r
+ </para>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: maint: END -->\r
+\r
+\r
+<!-- Section1: adv-issues -->\r
+\r
+ <sect1 id="adv-issues">\r
+ <title>Advanced Issues</title>\r
+\r
+ <indexterm>\r
+ <primary>(your index root)!advanced topics</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ <emphasis>You can get most things up and running in a quick and\r
+ dirty fashion, useful for testing and getting used to how things\r
+ work. For more serious use you would need to be a little more\r
+ advanced. This is the place to explain it all, if applicable.</emphasis>\r
+ </para>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: adv-issues: END -->\r
+\r
+\r
+<!-- Section1: moreinfo -->\r
+\r
+ <sect1 id="moreinfo">\r
+ <title>Further Information</title>\r
+\r
+ <indexterm>\r
+ <primary>(your index root)!information resources</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ <emphasis>A HOWTO cannot describe everything, some times the user\r
+ has to venture out on th enet to get more information or just\r
+ updates. Here is the place to tell where and how. Again examples\r
+ from the Multi Disk HOWTO, replace as needed.</emphasis> There is wealth\r
+ of information one should go through when setting up a major system,\r
+ for instance for a news or general Internet service provider. The\r
+ FAQs in the following groups are useful:\r
+ </para>\r
+\r
+<!-- Section2: newsgroups -->\r
+\r
+ <sect2 id="newsgroups">\r
+ <title>News groups</title>\r
+\r
+ <indexterm>\r
+ <primary>disk!information resources!news groups</primary>\r
+ </indexterm>\r
+\r
+ <para>Some of the most interesting news groups are:\r
+\r
+ <itemizedlist>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink url="news:comp.arch.storage">Storage</ulink>.\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink url="news:comp.sys.ibm.pc.hardware.storage">PC storage</ulink>.\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink url="news:alt.filesystems.afs">AFS</ulink>.\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink url="news:comp.periphs.scsi">SCSI</ulink>.\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink url="news:comp.os.linux.setup">Linux setup</ulink>.\r
+ </para>\r
+ </listitem>\r
+\r
+ </itemizedlist>\r
+ </para>\r
+\r
+ <para>\r
+ Most newsgroups have their own FAQ that are designed to answer most\r
+ of your questions, as the name Frequently Asked Questions indicate.\r
+ Fresh versions should be posted regularly to the relevant newsgroups.\r
+ If you cannot find it in your news spool you could go directly to the\r
+ <ulink url="ftp://rtfm.mit.edu/">FAQ main archive FTP site</ulink>.\r
+ The WWW versions can be browsed at the \r
+ <ulink url="http://www.cis.ohio-state.edu/hypertext/faq/usenet/FAQ-List.html">FAQ\r
+ main archive WWW site</ulink>.\r
+ </para>\r
+\r
+ <para>\r
+ Some FAQs have their own home site, of particular interest:\r
+\r
+ <itemizedlist>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink url="http://www.paranoia.com/~filipg/HTML/LINK/F_SCSI.html">SCSI FAQ</ulink> \r
+ and\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ <ulink url="http://alumni.caltech.edu/~rdv/comp_arch_storage/FAQ-1.html">comp.arch.storage FAQ</ulink>.\r
+ </para>\r
+ </listitem>\r
+\r
+ </itemizedlist>\r
+ </para>\r
+ </sect2>\r
+\r
+<!-- Section2: maillists -->\r
+\r
+ <sect2 id="maillists">\r
+ <title>Mailing Lists</title>\r
+\r
+ <indexterm>\r
+ <primary>disk!information resources!mailing lists</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ These are low-noise channels mainly for developers. Think twice\r
+ before asking questions there as noise delays the development.\r
+ Some relevant lists are <email>linux-raid</email>,\r
+ <email>linux-scsi</email> and <email>linux-ext2fs</email>. Many\r
+ of the most useful mailing lists run on the <Literal\r
+ remap="tt">vger.rutgers.edu</Literal> server but this is\r
+ notoriously overloaded, so try to find a mirror. There are some\r
+ lists mirrored at <ulink url="http://www.redhat.com">The Redhat\r
+ Home Page</ulink>. Many lists are also accessible at <ulink\r
+ url="http://www.linuxhq.com/lnxlists">linuxhq</ulink>, and the\r
+ rest of the web site contains useful information as well.\r
+ </para>\r
+\r
+ <para>\r
+ If you want to find out more about the lists available you can send\r
+ a message with the line <command>lists</command> to the list server\r
+ at <email>majordomo@vger.rutgers.edu</email>.\r
+ If you need help on how to use the mail server just send the line\r
+ <command>help</command> to the same address. Due to the\r
+ popularity of this server it is likely it takes a bit to time before\r
+ you get a reply or even get messages after you send a\r
+ <command>subscribe</command> command.\r
+ </para>\r
+\r
+ <para>\r
+ There is also a number of other majordomo list servers that can\r
+ be of interest such as the EATA driver list\r
+ (<email>linux-eata@mail.uni-mainz.de</email>)\r
+ and the Intelligent IO list <email>linux-i2o@dpt.com</email>.\r
+ </para>\r
+\r
+ <para>\r
+ Mailing lists are in a state of flux but you can find links to a\r
+ number of interesting lists from the \r
+ <ulink url="http://www.linuxdoc.org/">Linux Documentation\r
+ Homepage</ulink>.\r
+ </para>\r
+ </sect2>\r
+\r
+<!-- Section2: howto -->\r
+\r
+ <sect2 id="howto">\r
+ <title>HOWTO</title>\r
+\r
+ <indexterm>\r
+ <primary>disk!information resources!HOWTOs</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ These are intended as the primary starting points to get the\r
+ background information as well as show you how to solve a\r
+ specific problem. Some relevant HOWTOs are\r
+ <Literal remap="tt">Bootdisk</Literal>, \r
+ <Literal remap="tt">Installation</Literal>,\r
+ <Literal remap="tt">SCSI</Literal> and \r
+ <Literal remap="tt">UMSDOS</Literal>. The main site for these is the\r
+ <ulink url="http://www.linuxdoc.org/">LDP archive</ulink>at\r
+ Metalab (formerly known as Sunsite).\r
+ </para>\r
+\r
+ <para>\r
+ There is a a new HOWTO out that deals with setting up a DPT RAID\r
+ system, check out the\r
+ <ulink url="http://www.ram.org/computing/linux/dpt_raid.html">DPT RAID\r
+ HOWTO homepage</ulink>.\r
+ </para>\r
+ </sect2>\r
+\r
+<!-- Section2: local-res -->\r
+\r
+ <sect2 id="local-res">\r
+ <title>Local Resources</title>\r
+\r
+ <indexterm>\r
+ <primary>disk!information resources!local</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ In most distributions of Linux there is a document directory\r
+ installed, have a look in the <filename>/usr/doc</filename>\r
+ directory. where most packages store their main documentation and\r
+ README files etc. Also you will here find the HOWTO archive \r
+ (<filename>/usr/doc/HOWTO</filename>) of ready formatted HOWTOs\r
+ and also the mini-HOWTO archive \r
+ (<filename>/usr/doc/HOWTO/mini</filename>) of plain text\r
+ documents.\r
+ </para>\r
+\r
+ <para>\r
+ Many of the configuration files mentioned earlier can be found in\r
+ the <filename>/etc</filename> directory. In particular you will\r
+ want to work with the <filename>/etc/fstab</filename> file that\r
+ sets up the mounting of partitions and possibly also\r
+ <filename>/etc/raidtab</filename> file that is used for the\r
+ <Literal remap="tt">md</Literal> system to set up RAID.\r
+ </para>\r
+\r
+ <para>\r
+ The kernel source in <filename>/usr/src/linux</filename> is, of\r
+ course, the ultimate documentation. In other words, <quote>use\r
+ the source, Luke</quote>. It should also be pointed out that the\r
+ kernel comes not only with source code which is even commented\r
+ (well, partially at least) but also an informative\r
+ <filename>/usr/src/linux/Documentation</filename>. If you are\r
+ about to ask any questions about the kernel you should read this\r
+ first, it will save you and many others a lot of time and\r
+ possibly embarrassment.\r
+ </para>\r
+\r
+ <para>\r
+ Also have a look in your system log file\r
+ (<filename>/var/log/messages</filename>) to see what is going on\r
+ and in particular how the booting went if too much scrolled off\r
+ your screen. Using <command>tail -f /var/log/messages</command>\r
+ in a separate window or screen will give you a continuous update\r
+ of what is going on in your system.\r
+ </para>\r
+\r
+ <para>\r
+ You can also take advantage of the <filename>/proc</filename>\r
+ file system that is a window into the inner workings of your\r
+ system. Use <command>cat</command> rather than\r
+ <command>more</command> to view the files as they are reported as\r
+ being zero length. Reports are that <command>less</command> works\r
+ well here.\r
+ </para>\r
+ </sect2>\r
+\r
+<!-- Section2: web -->\r
+\r
+ <sect2 id="web">\r
+ <title>Web Sites</title>\r
+\r
+ <indexterm>\r
+ <primary>disk!information resources!WWW</primary>\r
+ </indexterm>\r
+ <indexterm>\r
+ <primary>disk!information resources!web pages</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ There are a huge number of informative web sites available. By\r
+ their very nature they change quickly so do not be surprised\r
+ if these links become quickly outdated.\r
+ </para>\r
+\r
+ <para>\r
+ A good starting point is of course the \r
+ <ulink url="http://www.linuxdoc.org/">Linux Documentation\r
+ Project</ulink> home page, an information central for\r
+ documentation, project pages and much more.\r
+ </para>\r
+\r
+ <para>\r
+ Please let me know if you have any other leads that can be \r
+ of interest.\r
+ </para>\r
+ </sect2>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: moreinfo: END -->\r
+\r
+\r
+<!-- Section1: help -->\r
+\r
+ <sect1 id="help">\r
+ <title>Getting Help</title>\r
+\r
+ <indexterm>\r
+ <primary>(your index root)!assistance, obtaining</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ In the end you might find yourself unable to solve your problems\r
+ and need help from someone else. The most efficient way is either\r
+ to ask someone local or in your nearest Linux user group, search\r
+ the web for the nearest one.\r
+ </para>\r
+\r
+ <para>\r
+ Another possibility is to ask on Usenet News in one of the many,\r
+ many newsgroups available. The problem is that these have such a\r
+ high volume and noise (called low signal-to-noise ratio) that your\r
+ question can easily fall through unanswered.\r
+ </para>\r
+\r
+ <para>\r
+ No matter where you ask it is important to ask well or you will\r
+ not be taken seriously. Saying just <emphasis remap="it">my disk\r
+ does not work</emphasis> is not going to help you and instead the\r
+ noise level is increased even further and if you are lucky someone\r
+ will ask you to clarify.\r
+ </para>\r
+\r
+ <para>\r
+ Instead describe your problems in some detail that will enable\r
+ people to help you. The problem could lie somewhere you did not\r
+ expect. Therefore you are advised to list the following information\r
+ about your system:\r
+ </para>\r
+\r
+ <para>\r
+ <variablelist>\r
+\r
+ <varlistentry>\r
+ <term>Hardware</Term>\r
+ <listitem>\r
+ <para>\r
+ <itemizedlist>\r
+ <listitem>\r
+ <para>Processor</para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>DMA</para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>IRQ</para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>Chip set (LX, BX etc)</para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>Bus (ISA, VESA, PCI etc)</para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ Expansion cards used (Disk controllers, video, IO \r
+ etc.)\r
+ </para>\r
+ </listitem>\r
+\r
+ </itemizedlist>\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+\r
+ <varlistentry>\r
+ <term>Software</term>\r
+ <listitem>\r
+ <para>\r
+ <itemizedlist>\r
+\r
+ <listitem>\r
+ <para>BIOS (On motherboard and possibly SCSI host adapters)</para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>LILO, if used</para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ Linux kernel version as well as possible modifications \r
+ and patches\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>Kernel parameters, if any</para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ Software that shows the error (with version number \r
+ or date)\r
+ </para>\r
+ </listitem>\r
+\r
+ </itemizedlist>\r
+ </para>\r
+\r
+ </listitem>\r
+ </varlistentry>\r
+\r
+ <varlistentry>\r
+ <term>Peripherals</term>\r
+ <listitem>\r
+ <para>\r
+ <itemizedlist>\r
+\r
+ <listitem>\r
+ <para>\r
+ Type of disk drives with manufacturer name, version and type\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>Other relevant peripherals</para>\r
+ </listitem>\r
+\r
+ </itemizedlist>\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+\r
+ </variablelist>\r
+ </para>\r
+\r
+ <para>\r
+ Remember that booting text is logged to\r
+ <filename>/var/log/messages</filename> which can answer most of\r
+ the questions above. Obviously if the drives fail you might not be\r
+ able to get the log saved to disk but you can at least scroll\r
+ back up the screen using the <keycap>SHIFT</keycap> and\r
+ <keycap>PAGE UP</keycap> keys. It may also be useful to include\r
+ part of this in your request for help but do not go overboard,\r
+ keep it <emphasis>brief</emphasis> as a complete log file dumped\r
+ to Usenet News is more than a little annoying.\r
+ </para>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: help: END -->\r
+\r
+\r
+<!-- Section1: remarks -->\r
+\r
+ <sect1 id="remarks">\r
+ <title>Concluding Remarks</title>\r
+\r
+ <indexterm>\r
+ <primary>(your index root)!conclusion</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ <emphasis>Just summing up... Also a place for general\r
+ recommendations.</emphasis>\r
+ </para>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: remarks: END -->\r
+\r
+\r
+<!-- Section1: faq -->\r
+\r
+ <sect1 id="faq">\r
+ <title>Questions and Answers</title>\r
+\r
+ <indexterm>\r
+ <primary>(your index root)!FAQ</primary>\r
+ </indexterm>\r
+ <indexterm>\r
+ <primary>(your index root)!frequently asked questions</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ <emphasis>Check the newsgroups and try to determine some frequent\r
+ problems and cover them here. Again an example from the Multi Disk\r
+ HOWTO.</emphasis>\r
+ </para>\r
+\r
+ <para>\r
+ This is just a collection of what I believe are the most common\r
+ questions people might have. Give me more feedback and I will turn\r
+ this section into a proper FAQ.\r
+ </para>\r
+\r
+ <para>\r
+ <itemizedlist>\r
+ <listitem>\r
+ <para>\r
+ Q:How many physical disk drives (spindles) does a Linux system need?\r
+ </para>\r
+\r
+ <para>\r
+ A: Linux can run just fine on one drive (spindle). Having\r
+ enough RAM (around 32 MB, and up to 64 MB) to support swapping\r
+ is a better price/performance choice than getting a second\r
+ disk. (E)IDE disk is usually cheaper (but a little slower) than\r
+ SCSI.\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ Q: Are there any disadvantages in this scheme?\r
+ </para>\r
+\r
+ <para>\r
+ A: There is only a minor snag: if even a single partition\r
+ overflows the system might stop working properly. The severity\r
+ depends of course on what partition is affected. Still this is\r
+ not hard to monitor, the command <command>df</command> gives\r
+ you a good overview of the situation. Also check the swap\r
+ partition(s) using <command>free</command> to make sure you are\r
+ not about to run out of virtual memory.\r
+ </para>\r
+ </listitem>\r
+\r
+ <listitem>\r
+ <para>\r
+ Q: OK, so should I split the system into as many partitions as \r
+ possible for a single drive?\r
+ </para>\r
+\r
+ <para>\r
+ A: No, there are several disadvantages to that. First of all\r
+ maintenance becomes needlessly complex and you gain very little\r
+ in this. In fact if your partitions are too big you will seek\r
+ across larger areas than needed. This is a balance and\r
+ dependent on the number of physical drives you have.\r
+ </para>\r
+ </listitem>\r
+\r
+ </itemizedlist>\r
+\r
+ <comment>\r
+ Greg Leblanc: Depending on how big this FAQ gets, perhaps it\r
+ would be worthwhile to have, say, the 5 most FAQ, and put the\r
+ rest into an external FAQ. Dunno. Comments?\r
+ </comment>\r
+\r
+ <emphasis>(rest deleted.)</emphasis>\r
+ </para>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: faq: END -->\r
+\r
+\r
+<!-- Section1: bits-n-pieces -->\r
+\r
+ <sect1 id="bits-n-pieces">\r
+ <title>Bits and Pieces </title>\r
+\r
+ <indexterm>\r
+ <primary>disk!miscellaneous</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ This is basically a section where I stuff all the bits I have not\r
+ yet decided where should go, yet that I feel is worth knowing\r
+ about. It is a kind of transient area.\r
+ </para>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: bits-n-pieces: END -->\r
+\r
+\r
+<!-- Section1: examples -->\r
+\r
+ <sect1 id="examples">\r
+ <title>Examples</title>\r
+\r
+ <indexterm>\r
+ <primary>(your index root)!examples</primary>\r
+ </indexterm>\r
+\r
+ <para>\r
+ <emphasis>Example designs and sample configuration files and other\r
+ relevant details is always handy</emphasis>\r
+ </para>\r
+\r
+ </sect1>\r
+\r
+<!-- Section1: examples: END -->\r
+\r
+</article>\r
+\r
+<!-- Keep this comment at the end of the file\r
+Local variables:\r
+mode: sgml\r
+sgml-omittag:t\r
+sgml-shorttag:t\r
+sgml-namecase-general:t\r
+sgml-general-insert-case:lower\r
+sgml-minimize-attributes:nil\r
+sgml-always-quote-attributes:t\r
+sgml-indent-step:1\r
+sgml-indent-data:nil\r
+sgml-parent-document:nil\r
+sgml-exposed-tags:nil\r
+sgml-local-catalogs:nil\r
+sgml-local-ecat-files:nil\r
+End:\r
+-->\r
projects / fspm_howto / commitdiff