svn commit: r51986 - head/en_US.ISO8859-1/books/porters-handbook/special

[Mathieu Arnold]

Author: mat
Date: Tue Jul 10 22:28:06 2018
New Revision: 51986
URL: https://svnweb.freebsd.org/changeset/doc/51986

Log:
  Add a note about MAKE_JOBS_UNSAFE and the importance to not why it is set.
  
  Sponsored by:	Absolight

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

Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml	Tue Jul 10 08:38:43 2018	(r51985)
+++ head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml	Tue Jul 10 22:28:06 2018	(r51986)
@@ -514,6 +514,16 @@ IGNORE=	may not be redistributed because of licensing 
 	<literal>MAKE_JOBS_UNSAFE=yes</literal> variable.  It is
 	used when a port is known to be broken with
 	<varname>-jX</varname>.</para>
+
+      <important>
+	<para>When setting <varname>MAKE_JOBS_UNSAFE</varname>, it
+	  is very important to explain either with a comment in the
+	  <filename>Makefile</filename>, or at least in the commit
+	  message, <emphasis>why</emphasis> the port does not build
+	  when enabling.  Otherwise, it is almost impossible to
+	  either fix the problem, or test if it has been fixed when
+	  committing an update at a later date.</para>
+      </important>
     </sect2>
 
     <sect2 xml:id="using-make">