newxml/chapter01/askforhelp.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
   3   <!ENTITY % general-entities SYSTEM "../general.ent">
   4   %general-entities;
   5 ]>
   6 <sect1 id="prepare-askforhelp">
   7 <title>How to ask for help</title>
   8 <?dbhtml filename="askforhelp.html"?>
   9
  10 <para>If you run into a problem while working through this book, you should
  11 first check the FAQ at <ulink url="&faq-root;"/> -- often your question
  12 is already answered there. If it is not, you should try to find the source of
  13 the problem. The following hint might give you some ideas for your
  14 troubleshooting: <ulink url="&hints-root;errors.txt"/>.</para>
  15
  16 <para>If all that fails, you will find that most people on IRC and the mailing
  17 lists (see <xref linkend="ch-scatter-administrativa"/>) are willing to help
  18 you. But to assist them in diagnosing and solving your problem, please include
  19 all relevant information in your request for help.</para>
  20
  21 <sect2>
  22 <title>Things to mention</title>
  23
  24 <para>Apart from a brief explanation of the problem you're having, the
  25 essential things to include in your request are:</para>
  26
  27 <itemizedlist>
  28 <listitem><para>the version of the book you are using (being &version;),</para></listitem>
  29 <listitem><para>the host distribution and version you are using to create
  30 LFS,</para></listitem>
  31 <listitem><para>the package or section giving you problems,</para></listitem>
  32 <listitem><para>the exact error message or symptom you are receiving,</para></listitem>
  33 <listitem><para>whether you have deviated from the book at all.</para></listitem>
  34 </itemizedlist>
  35
  36 <para>(Note that saying that you've deviated from the book doesn't mean
  37 that we won't help you. After all, LFS is about choice. It'll just
  38 help us to see other possible causes of your problem.)</para>
  39
  40 </sect2>
  41
  42 <sect2>
  43 <title>Configure problems</title>
  44
  45 <para>When something goes wrong during the stage where the configure script
  46 is run, look through the <filename>config.log</filename> file. This file
  47 may contain errors encountered during configure which weren't printed to
  48 the screen. Include those relevant lines if you decide to ask for
  49 help.</para>
  50
  51 </sect2>
  52
  53 <sect2>
  54 <title>Compile problems</title>
  55
  56 <para>To help us find the cause of the problem, both screen output and
  57 the contents of various files are useful. The screen output from both
  58 the ./configure script and the make run can be useful. Don't blindly
  59 include the whole thing but, on the other hand, don't include too little.
  60 As an example, here is some screen output from make:</para>
  61
  62 <screen>gcc -DALIASPATH=\"/mnt/lfs/usr/share/locale:.\"
  63 -DLOCALEDIR=\"/mnt/lfs/usr/share/locale\" -DLIBDIR=\"/mnt/lfs/usr/lib\"
  64 -DINCLUDEDIR=\"/mnt/lfs/usr/include\" -DHAVE_CONFIG_H -I. -I.
  65 -g -O2 -c getopt1.c
  66 gcc -g -O2 -static -o make ar.o arscan.o commands.o dir.o expand.o file.o
  67 function.o getopt.o implicit.o job.o main.o misc.o read.o remake.o rule.o
  68 signame.o variable.o vpath.o default.o remote-stub.o version.o opt1.o
  69 -lutil job.o: In function `load_too_high':
  70 /lfs/tmp/make-3.79.1/job.c:1565: undefined reference to `getloadavg'
  71 collect2: ld returned 1 exit status
  72 make[2]: *** [make] Error 1
  73 make[2]: Leaving directory `/lfs/tmp/make-3.79.1'
  74 make[1]: *** [all-recursive] Error 1
  75 make[1]: Leaving directory `/lfs/tmp/make-3.79.1'
  76 make: *** [all-recursive-am] Error 2</screen>
  77
  78 <para>In this case, many people just include the bottom section where it
  79 says:</para>
  80
  81 <screen>make [2]: *** [make] Error 1</screen>
  82
  83 <para>and onwards. This isn't enough for us to diagnose the problem because it
  84 only tells us that <emphasis>something</emphasis> went wrong, not
  85 <emphasis>what</emphasis> went wrong. The whole section, as in the example
  86 above, is what should be included to be helpful, because it includes the
  87 command that was executed and the command's error message(s).</para>
  88
  89 <para>An excellent article on asking for help on the Internet in general
  90 has been written by Eric S. Raymond. It is available online at
  91 <ulink url="http://catb.org/~esr/faqs/smart-questions.html"/>.
  92 Read and follow the hints in that document and you are much more likely
  93 to get a response to start with and also to get the help you actually
  94 need.</para>
  95
  96 </sect2>
  97
  98 <sect2>
  99 <title>Test suite problems</title>
 100
 101 <para>Many packages provide a test suite which, depending on the importance
 102 of the package, we may encourage you to run. Sometimes packages will
 103 generate false or expected failures. If you encounter these, you can check
 104 the LFS Wiki page at <ulink url="&wiki-root;"/> to see whether we have
 105 already noted and investigated them. If we already know
 106 about them, then usually there is no need to be concerned.</para>
 107
 108 </sect2>
 109
 110
 111 </sect1>