Gentoo Archives: gentoo-doc-cvs

From: "Joshua Saddler (nightmorph)" <nightmorph@g.o>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] gentoo commit in xml/htdocs/doc/en/handbook: hb-working-features.xml
Date: Tue, 13 Jul 2010 00:27:05
Message-Id: 20100713002659.847B42CE14@corvid.gentoo.org
1 nightmorph 10/07/13 00:26:59
2
3 Modified: hb-working-features.xml
4 Log:
5 redo the ccache section so it's not recommended for everyone. make it clear that it's for folks doing development work, and that ccache is known to cause numerous compile failures. also added a suggestion to disable ccache and recompile before reporting any bugs. bug 327945.
6
7 Revision Changes Path
8 1.37 xml/htdocs/doc/en/handbook/hb-working-features.xml
9
10 file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/handbook/hb-working-features.xml?rev=1.37&view=markup
11 plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/handbook/hb-working-features.xml?rev=1.37&content-type=text/plain
12 diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/handbook/hb-working-features.xml?r1=1.36&r2=1.37
13
14 Index: hb-working-features.xml
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-working-features.xml,v
17 retrieving revision 1.36
18 retrieving revision 1.37
19 diff -u -r1.36 -r1.37
20 --- hb-working-features.xml 2 Mar 2008 17:58:39 -0000 1.36
21 +++ hb-working-features.xml 13 Jul 2010 00:26:59 -0000 1.37
22 @@ -4,7 +4,7 @@
23 <!-- The content of this document is licensed under the CC-BY-SA license -->
24 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
25
26 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-working-features.xml,v 1.36 2008/03/02 17:58:39 rane Exp $ -->
27 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-working-features.xml,v 1.37 2010/07/13 00:26:59 nightmorph Exp $ -->
28
29 <sections>
30
31 @@ -13,8 +13,8 @@
32 ccache and more.
33 </abstract>
34
35 -<version>1.32</version>
36 -<date>2008-03-02</date>
37 +<version>1.33</version>
38 +<date>2010-07-12</date>
39
40 <section>
41 <title>Portage Features</title>
42 @@ -132,10 +132,12 @@
43 <body>
44
45 <p>
46 -<c>ccache</c> is a fast compiler cache. When you compile a program, it will
47 +<c>ccache</c> is a fast compiler cache. When you compile a program, it will
48 cache intermediate results so that, whenever you recompile the same program, the
49 -compilation time is greatly reduced. In common compilations this can result in 5
50 -to 10 times faster compilation times.
51 +compilation time is greatly reduced. The first time you run ccache, it will be
52 +much slower than a normal compilation. Subsequent recompiles should be faster.
53 +ccache is only helpful if you will be recompiling the same application many
54 +times; thus it's mostly only useful for software developers.
55 </p>
56
57 <p>
58 @@ -143,6 +145,16 @@
59 <uri link="http://ccache.samba.org">ccache homepage</uri>.
60 </p>
61
62 +<warn>
63 +<c>ccache</c> is known to cause numerous compilation failures. Sometimes ccache
64 +will retain stale code objects or corrupted files, which can lead to packages
65 +that cannot be emerged. If this happens (if you receive errors like "File not
66 +recognized: File truncated"), try recompiling the application with ccache
67 +disabled (<c>FEATURES="-ccache"</c> in <path>/etc/make.conf</path>)
68 +<e>before</e> reporting a bug. Unless you are doing development work, <e>do not
69 +enable ccache</e>.
70 +</warn>
71 +
72 </body>
73 </subsection>
74 <subsection>