README,blhc: Documentation update.

[blhc/blhc.git] / README

diff --git a/README b/README
index 7b575b5da8b8b2ede674a440c7bd922dca127947..e039ce99cf44634933be6ab14514929dc59f693b 100644 (file)
--- a/README
+++ b/README
@@ -13,8 +13,9 @@ all compiler commands use the correct hardening flags and thus all hardening
 features are correctly used.
 
 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
-tools using dpkg-buildpackage like pbuilder or the official buildd build logs)
-to help maintainers detect missing hardening flags in their packages.
+tools using dpkg-buildpackage like pbuilder or sbuild (which is used for the
+official buildd build logs)) to help maintainers detect missing hardening
+flags in their packages.
 
 At the moment it works only on Debian and derivatives but it should be easily
 extendable to other systems as well. Patches are welcome.
@@ -100,6 +101,14 @@ following line (output of dpkg-buildpackage):
 The available hardening flags are adapted to the architecture because some
 architectures don't support certain hardening options.
 
+Some checks (Ada and hardening-wrapper at the moment) check the build
+dependencies for certain packages. The following lines are used to get the
+build dependencies. The first is used in buildd build logs, the second by
+pbuilder logs, both are detected:
+
+    Build-Depends: ...
+    Depends: ...
+
 
 LIMITATIONS
 -----------
@@ -110,7 +119,7 @@ real compile process (output of dpkg-buildpackage):
     dpkg-buildpackage: ...
 
 If it's not present no compiler commands are detected. In case you don't use
-dpkp-buildpackage but still want to check a build log adding it as first line
+dpkp-buildpackage but still want to check a build log, adding it as first line
 should work fine.
 
 The following non-verbose builds can't be detected:
@@ -160,7 +169,7 @@ LICENSE
 
 blhc is licensed under GPL version 3 or later.
 
-Copyright (C) 2012  Simon Ruderich
+Copyright (C) 2012-2013  Simon Ruderich
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by