From cbcabdf522457c91ca454e4e607b911f8311f29d Mon Sep 17 00:00:00 2001
From: Dmitry Marakasov <amdmi3@FreeBSD.org>
Date: Fri, 9 Sep 2016 20:04:27 +0000
Subject: [PATCH] - Document that verbose builds are strongly preferred

Submitted by:	amdmi3
Reviewed by:	mat, wblock
Approved by:	mat, wblock
Differential Revision:	D7533
---
 .../porters-handbook/porting-dads/chapter.xml | 26 +++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml b/en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml
index b851a2acf3..ad62db4ea4 100644
--- a/en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml
+++ b/en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml
@@ -322,6 +322,32 @@ exec %%LOCALBASE%%/bin/java -jar %%DATADIR%%/foo.jar "$@"</programlisting>
     <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>