svn commit: r49378 - head/en_US.ISO8859-1/books/porters-handbook/porting-dads

Dmitry Marakasov amdmi3 at FreeBSD.org
Fri Sep 9 20:04:28 UTC 2016


Author: amdmi3 (ports committer)
Date: Fri Sep  9 20:04:27 2016
New Revision: 49378
URL: https://svnweb.freebsd.org/changeset/doc/49378

Log:
  - Document that verbose builds are strongly preferred
  
  Submitted by:	amdmi3
  Reviewed by:	mat, wblock
  Approved by:	mat, wblock
  Differential Revision:	D7533

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml

Modified: head/en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml	Fri Sep  9 17:31:58 2016	(r49377)
+++ head/en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml	Fri Sep  9 20:04:27 2016	(r49378)
@@ -322,6 +322,32 @@ exec %%LOCALBASE%%/bin/java -jar %%DATAD
     <programlisting>CFLAGS+= -DHAVE_SOUND</programlisting>
   </sect1>
 
+  <sect1 xml:id="dads-verbose-logs">
+    <title>Verbose Build Logs</title>
+
+    <para>Make the port build system display all commands executed
+      during the build stage.  Complete build logs are crucial to
+      debugging port problems.</para>
+
+    <para>Non-informative build log example (bad):</para>
+
+    <programlisting>  CC     source1.o
+  CC     source2.o
+  CCLD   someprogram</programlisting>
+
+    <para>Verbose build log example (good):</para>
+
+    <programlisting>cc -O2 -pipe -I/usr/local/include -c -o source1.o source1.c
+cc -O2 -pipe -I/usr/local/include -c -o source2.o source2.c
+cc -o someprogram source1.o source2.o -L/usr/local/lib -lsomelib</programlisting>
+
+    <para>Some build systems such as <application>CMake</application>,
+      <application>ninja</application>, and <application>GNU
+      configure</application> are set up for verbose logging by
+      the ports framework.  In other cases, ports might need
+      individial tweaks.</para>
+  </sect1>
+
   <sect1 xml:id="dads-feedback">
     <title>Feedback</title>
 


More information about the svn-doc-all mailing list