Details

Reviewers

wblock
mat

Commits

rD49378: - Document that verbose builds are strongly preferred

Summary

Some ports build silently, hiding executed commands under non-informative summary, such as

CC     source1.o
CC     source2.o
CCLD   someprogram

This is unacceptable as build logs are crucial to debugging port
build problems both on the cluster and based on end user feedback
and also global mining of build problems such as non-respected
C(XX)FLAGS and incorrect -I/-L ordering. Lets start with documenting
the policy of verbose build in the PHB.

Diff Detail

Repository

rD FreeBSD doc repository - subversion

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

AMDmi3 updated this revision to Diff 19360.Aug 16 2016, 4:18 PM

AMDmi3 retitled this revision from to Introduce policy of preferring verbose logs.

AMDmi3 updated this object.

AMDmi3 edited the test plan for this revision. (Show Details)

Herald added a reviewer: mat. · View Herald TranscriptAug 16 2016, 4:18 PM

AMDmi3 added a child revision: D7534: Switch to verbose logs by default.Aug 16 2016, 4:44 PM

mat added inline comments.Aug 17 2016, 11:59 AM

en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml
328 ↗	(On Diff #19360)	Don't use should, it is feeble and suggests unsureness. Attempt to be imperative: "do this" rather than "you should do this".
346–349 ↗	(On Diff #19360)	I think this should go in bsd.port.mk, so that all GNU_CONFIGURE ports use it.

Better wording

Herald edited edge metadata. · View Herald TranscriptAug 17 2016, 12:21 PM

AMDmi3 marked an inline comment as done.Aug 17 2016, 12:22 PM

AMDmi3 added inline comments.

en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml
346–349 ↗	(On Diff #19360)	See D7534, that doesn't seem to be possible.

This is waiting on exp-run https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=212075 to check whether adding --disable-silent-rules to CONFIGURE_ARGS for GNU_CONFIGURE case is possible. If it is, this will need simplification and removal of last paragraphs.

Seems like it's feasible to add --disable-silent-rules to CONFIGURE_ARGS
by default, so remove mention of manual actions.

Herald edited edge metadata. · View Herald TranscriptSep 6 2016, 2:40 PM

Looks good to me, add Warren for the english :-)

wblock added inline comments.Sep 9 2016, 12:26 PM

en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml
328 ↗	(On Diff #20091)	s/output/display/
329 ↗	(On Diff #20091)	"verbosely" is redundant here. Also, split sentence here: during the build stage. Do not hide the output with a
347 ↗	(On Diff #20091)	Split sentence, and missing comma: verbose logging by the ports framework. In other cases, ports
348 ↗	(On Diff #20091)	s/may/might/