Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 8 Nov 2001 14:23:14 -0500
From:      Michael Lucas <mwlucas@blackhelicopters.org>
To:        doc@freebsd.org
Subject:   finding stuff in documentation
Message-ID:  <20011108142314.A10189@blackhelicopters.org>

next in thread | raw e-mail | index | archive | help

--KsGdsel6WgEHnImy
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

Folks,

At one point, several months ago, I was looking at a problem-solving
mechanism for FreeBSD.  Unfortunately, my book contract got in the
way.  I've had time to reconsider this issue, and I think I've
narrowed it down considerably.  (My original solution would have taken
a huge amount of my time and been maintainable only by yours truly, or
some other poor loser with no life.)

As a user, when I have a problem with something I don't want to ask on
a mailing list or call a vendor.  I want to look up the error, find
out what it means, fix it, and get on with life.

Right now, we encourage people to look up their errors in the FAQ,
Handbook, articles, and mailing list archives.  This is a lot of
places to look, but we have no choice.  I frequently have to click
through several different pages of messages to find what I really
want.

Attached please find a first stab at addressing this issue: a FreeBSD
"error code" index.  It's an extra chapter that goes through the FAQ
and lists every <errorname> entry in alphabetical order.  It's alpha
quality, questionable markup and ancestry, but it compiles so I'm
shipping it out for comments.

Some errors appear in multiple areas, or are described in different
sections of the FAQ.  IMHO, these might indicate areas where the FAQ
could use some cleanup, rearranging, or merging.

A decent index would also help us manage the content of the Handbook
and FAQ.

Is there any DocProj interest in having this?  Shall I drop it now,
change, or continue?

==ml

-- 
Michael Lucas
mwlucas@blackhelicopters.org
http://www.blackhelicopters.org/~mwlucas/
Big Scary Daemons: http://www.oreillynet.com/pub/q/Big_Scary_Daemons

--KsGdsel6WgEHnImy
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename=error-index

*** en_US.ISO8859-1/books/faq/book.sgml-dist	Thu Nov  8 07:46:11 2001
--- en_US.ISO8859-1/books/faq/book.sgml	Thu Nov  8 14:09:27 2001
***************
*** 12342,12347 ****
--- 12342,12688 ----
      </qandaset>
    </chapter>
  
+   <chapter id="errors-index">
+     <chapterinfo>
+       <author>
+         <firstname>Michael</firstname>
+         <surname>Lucas</surname>
+         <affiliation>
+           <address><email>mwlucas@blackhelicopters.org</email></address>
+         </affiliation>
+       </author>
+     </chapterinfo>
+ 
+     <title>Errors Index</title>
+ 
+     <para>FreeBSD system errors are listed here, in alphabetical
+       order.  This is not an encyclopedic list of errors, merely those
+       that appear in the FreeBSD FAQ and Handbook.</para>
+ 
+     <para>Some error messages have device names in front of them.
+       These errors could affect any number of devices, so look for the
+       error without the device name.</para>
+ 
+     <qandaset>
+       <qandaentry>
+         <question id="archsw-readin-failed-index">
+           <para><errorname>archsw.readin.failed</errorname></para>
+         </question>
+ 
+         <answer>
+           <para>See <link
+             linkend="archsw-readin-failed-error">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+       <qandaentry>
+         <question id="bad-sector-table-not-supported-index">
+           <para><errorname>bad sector table not
+             supported</errorname></para>
+         </question>
+ 
+         <answer>
+           <para>See <link linkend="bad144-3x-4x">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="brkadrint-illegal-index">
+           <para><errorname>brkadrint, Illegal Host Acces at seqaddr
+             0x0</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link
+             linkend="brkadrint-illegal-host-access">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="calcru-negative-time-index">
+           <para><errorname>calcru: negative time</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="calcru-negative">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="cant-change-attributes-index">
+           <para><errorname>can't change attributes</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="exports-errors">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="cant-find-libc-index">
+           <para><errorname>can't find libc.so.X.0</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="missing-libcso40">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="cmap-busy-index">
+           <para><errorname>CMAP busy</errorname></para>
+         </question>
+ 
+         <answer>
+           <para>See <link linkend="cmap-busy-panic">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="couldnt-open-console-index">
+           <para><errorname>Couldn't open console</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="xconsole-failure">this
+             </link> FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="device-not-configured">
+           <para><errorname>Device not configured</errorname></para>
+         </question>
+ 
+         <answer>
+           <para>See <link linkend="cdrom-not-configured">this</link>
+             FAQ if you're using a CDROM.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="ed1-timeout-index">
+           <para><errorname>ed1: timeout</errorname></para>
+         </question>
+ 
+         <answer>
+           <para>See <link linkend="ed1-timeout">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="file-table-full-index">
+           <para><errorname>file: table is full</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="file-table-full">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="incorrect-super-block-index">
+           <para><errorname>Incorrect super block</errorname></para>
+         </question>
+ 
+         <answer>
+           <para>See <link linkend="mount-cd-superblock">this</link>
+             FAQ if you're using a CDROM.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="KDENABIO-failed-index">
+           <para><errorname>KDENABIO failed (Operation not
+             permitted)</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="running-X-securelevels">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="mail-loops-index">
+           <para><errorname>mail loops back to myself</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>This is a Sendmail problem.  See <link
+             linkend="mail-loopback">this</link> FreeBSD FAQ for a
+             brief explanation.  See <ulink
+             URL="http://www.sendmail.org/faq/">the Sendmail
+             FAQ</ulink> for more information</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="missing-operating-system-index">
+           <para><errorname>Missing Operating System</errorname></para>
+         </question>
+ 
+         <answer>
+           <para>See <link linkend="missing-os">this</link> FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="nlist-failed-index">
+           <para><errorname>nlist failed</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="nlist-failed">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="no-route-to-host-index">
+           <para><errorname>No route to host</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>If you're using &man.ppp.8;, see <link
+             linkend="no-route-to-host">this</link> FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="panic-cant-mount-root-index">
+           <para><errorname>panic: can't mount root</errorname></para>
+         </question>
+ 
+         <answer>
+           <para>See <link linkend="panic-on-install-reboot">this
+             </link>FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="panic-kmem-map-too-small-index">
+           <para><errorname>panic: kmem_map too small</errorname></para>
+         </question>
+ 
+         <answer>
+           <para>See <link linkend="panic-kmemmap-too-small">this
+             </link>FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="pcm0-not-found-index">
+           <para><errorname>pcm0 not found</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="pcm0-not-found">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="permission-denied-index">
+           <para><errorname>Permission denied</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>If this happens with network operations, see <link
+             linkend="network-permission-denied">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="read-error-index">
+           <para><errorname>Read error</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="boot-read-error">this</link> FAQ
+             and <link linkend="dangerously-dedicated">this</link> FAQ
+             if it happens at boot.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="root-not-found-index">
+           <para><errorname>root: not found</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link
+             linkend="root-not-found-cron-errors">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="signal11-index">
+           <para><errorname>signal 11</errorname></para>
+         </question>
+ 
+         <answer>
+           <para>See <link linkend="signal11">this</link> FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="socksys-index">
+           <para><errorname>socksys</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="sco-socksys">this</link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="stray-irq-index">
+           <para><errorname>stray IRQ</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="stray-irq">this</link> FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="pnp-resources-index">
+           <para><errorname>unknown: &lt;PNP0303&gt; can't assign
+             resources</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="pnp-resources">this </link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+ 
+       <qandaentry>
+         <question id="not-in-correct-group">
+           <para><errorname>you are not in the correct group to su
+             root</errorname></para>
+ 	</question>
+ 
+         <answer>
+           <para>See <link linkend="su-wheel-group">this </link>
+             FAQ.</para>
+         </answer>
+       </qandaentry>
+     </qandaset>
+   </chapter>
+ 
    <chapter id="acknowledgments">
      <title>Acknowledgments</title>
  

--KsGdsel6WgEHnImy--

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?20011108142314.A10189>