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