source: BOOK/introduction/common/askforhelp.xml @ 32f1da4

Last change on this file since 32f1da4 was 32f1da4, checked in by Joe Ciccone <jciccone@…>, 14 years ago

Updated the askforhelp page so we cant get more information about their build.

  • Property mode set to 100644
File size: 5.6 KB
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3  "" [
4  <!ENTITY % general-entities SYSTEM "../../general.ent">
5  %general-entities;
8<sect1 id="ch-intro-askforhelp">
9  <?dbhtml filename="askforhelp.html"?>
11  <title>Help</title>
13  <para>If an issue or a question is encountered while working through
14  this book, check the FAQ page at <ulink url="&faq-root;#generalfaq"/>.
15  Questions are often already answered there. If your question is not
16  answered on this page, try to find the source of the problem. The
17  following hint will give you some guidance for troubleshooting:
18  <ulink url="&hints-root;errors.txt"/>.</para>
20  <para>We also have a wonderful CLFS community that is willing to offer
21  assistance through the mailing lists and IRC (see the <xref
22  linkend="ch-intro-resources"/> section of this book). However, we
23  get several support questions everyday and many of them can be easily
24  answered by going to the FAQ and by searching the mailing lists first.
25  So for us to offer the best assistance possible, you need to do some
26  research on your own first. This allows us to focus on the more unusual
27  support needs. If your searches do not produce a solution, please include
28  all relevant information (mentioned below) in your request for help.</para>
30  <sect2>
31    <title>Things to Mention</title>
33    <para>Apart from a brief explanation of the problem being experienced,
34    the essential things to include in any request for help are:</para>
36    <itemizedlist>
37      <listitem>
38        <para>The version of the book being used (in this case
39        &version;)</para>
40      </listitem>
41      <listitem>
42        <para>The host distribution and version being used to
43        create CLFS.</para>
44      </listitem>
45      <listitem>
46        <para>The architecture of the host and target.</para>
47      </listitem>
48      <listitem>
49        <para>The value of the $CLFS_HOST, $CLFS_TARGET, $BUILD32, and $BUILD64
50        enviornment variables.</para>
51      </listitem>
52      <listitem>
53        <para>The package or section in which the problem was encountered.</para>
54      </listitem>
55      <listitem>
56        <para>The exact error message or symptom received. See <xref
57        linkend="ch-intro-askforhelp-compilation-problems"/> below for an
58        example.</para>
59      </listitem>
60      <listitem>
61        <para>Note whether you have deviated from the book at all. A package
62        change or even a minor change to any command is considered deviation.
63        </para>
64      </listitem>
65    </itemizedlist>
67    <note>
68      <para>Deviating from this book does <emphasis>not</emphasis>
69      mean that we will not help you. After all, the CLFS project is
70      about personal preference. Be upfront about any changes to
71      the established procedure, this helps us evaluate and determine
72      possible causes of your problem.</para>
73    </note>
75  </sect2>
77  <sect2>
78    <title>Configure Script Problems</title>
80    <para>If something goes wrong while running the <command>configure</command>
81    script, review the <filename>config.log</filename> file. This file may
82    contain the errors you encountered <command>configure</command>. This file
83    logs errors that may have not been printed to the screen. Include only the
84    <emphasis>relevant</emphasis> lines if you need to ask for help.</para>
86  </sect2>
88  <sect2 id="ch-intro-askforhelp-compilation-problems">
89    <title>Compilation Problems</title>
91    <para>Both the screen output and the contents of various files are
92    useful in determining the cause of compilation problems. The screen output
93    from the <command>configure</command> script and the
94    <command>make</command> run can be helpful. It is not necessary to
95    include the entire output, but do include enough of the relevant
96    information. Below is an example of the type of information to include
97    from the screen output from <command>make</command>:</para>
99<screen><computeroutput>gcc -DALIASPATH=\"/mnt/clfs/usr/share/locale:.\"
102-DINCLUDEDIR=\"/mnt/clfs/usr/include\" -DHAVE_CONFIG_H -I. -I.
103-g -O2 -c getopt1.c
104gcc -g -O2 -static -o make ar.o arscan.o commands.o dir.o
105expand.o file.o function.o getopt.o implicit.o job.o main.o
106misc.o read.o remake.o rule.o signame.o variable.o vpath.o
107default.o remote-stub.o version.o opt1.o
108-lutil job.o: In function `load_too_high':
109/clfs/tmp/make-3.79.1/job.c:1565: undefined reference
110to `getloadavg'
111collect2: ld returned 1 exit status
112make[2]: *** [make] Error 1
113make[2]: Leaving directory `/clfs/tmp/make-3.79.1'
114make[1]: *** [all-recursive] Error 1
115make[1]: Leaving directory `/clfs/tmp/make-3.79.1'
116make: *** [all-recursive-am] Error 2</computeroutput></screen>
118    <para>In this case, many people would just include the bottom
119    section:</para>
121<screen><computeroutput>make [2]: *** [make] Error 1</computeroutput></screen>
123    <para>This is not enough information to properly diagnose the problem
124    because it only notes that something went wrong, not
125    <emphasis>what</emphasis> went wrong.  The entire section, as in the
126    example above, is what should be saved because it includes the command
127    that was executed and the associated error message(s).</para>
129    <para>An excellent article about asking for help on the Internet is
130    available online at <ulink
131    url=""/>.  Read and
132    follow the hints in this document to increase the likelihood of getting
133    the help you need.</para>
135  </sect2>
Note: See TracBrowser for help on using the repository browser.