cookutils diff doc/cookutils.en.html @ rev 49

cook + cooker + doc: add blocked functionality and information
author Christophe Lincoln <pankso@slitaz.org>
date Sat May 07 05:34:17 2011 +0200 (2011-05-07)
parents 12fe3e17e20a
children 99f1b17a5659
line diff
     1.1 --- a/doc/cookutils.en.html	Sat May 07 02:14:20 2011 +0200
     1.2 +++ b/doc/cookutils.en.html	Sat May 07 05:34:17 2011 +0200
     1.3 @@ -26,7 +26,9 @@
     1.4  	Cook let you compile and create a package, provide a log file and check
     1.5  	receipt/package quality. The Cooker is a build bot with more automation
     1.6  	and can be used as a frontend to cook, since it provide a CGI/web interface
     1.7 -	who let you view cook logs in a nice and colored way.
     1.8 +	who let you view cook logs in a nice and colored way. Cook and the Cooker
     1.9 +	use the same DB files and wok, ther share <a href="#blocked">blocked</a>
    1.10 +	and broken packages as well as activity.
    1.11  </p>
    1.12  
    1.13  <h3>Cook usage</h3>
    1.14 @@ -242,6 +244,29 @@
    1.15  # cooker cat [category]
    1.16  </pre>
    1.17  
    1.18 +<a name="blocked"></a>
    1.19 +<h3>Blocked packages</h3>
    1.20 +<p>
    1.21 +	Cook and the Cooker handle a file with a list of blocked package so they
    1.22 +	not cook when commits appends or if a cooklist is used. This is very useful
    1.23 +	for a Cooker Build Bot in production. When you block or unblock a package
    1.24 +	you can add a note to the cooknotes. Blocking packages example:
    1.25 +</p>
    1.26 +<pre>
    1.27 +# cook pkgname --block
    1.28 +# cooker block pkgname
    1.29 +# cooker -n "Blocked pkgname note"
    1.30 +</pre>
    1.31 +<p>
    1.32 +	The list of blocked packages are also displayed on the Cooker web interface.
    1.33 +	To unblock a package you have to use the unblock command or cook --unblock
    1.34 +	option:
    1.35 +</p>
    1.36 +<pre>
    1.37 +# cook pkgname --unblock
    1.38 +# cooker unblock pkgname
    1.39 +</pre>
    1.40 +
    1.41  <h3>Cooker CGI/Web</h3>
    1.42  <p>
    1.43  	To let you view log files in a nice way, keep activity trace and help find