]> ruderich.org/simon Gitweb - blhc/blhc.git/commitdiff
README,blhc: Documentation update.
authorSimon Ruderich <simon@ruderich.org>
Wed, 14 Aug 2013 15:58:31 +0000 (17:58 +0200)
committerSimon Ruderich <simon@ruderich.org>
Wed, 14 Aug 2013 15:58:31 +0000 (17:58 +0200)
README
bin/blhc

diff --git a/README b/README
index 605ab680efbf447c8e8a42d49b12c8768933efe6..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.
@@ -118,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:
index 9ed648aa1a7be09fabffa22514b7cabb35a87166..c77a16cedddc3c91333098f9a96a4104abdaae6a 100755 (executable)
--- a/bin/blhc
+++ b/bin/blhc
@@ -1267,14 +1267,18 @@ blhc is a small tool which checks build logs for missing hardening flags. It's
 licensed under the GPL 3 or later.
 
 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.
 
 Only gcc is detected as compiler at the moment. If other compilers support
 hardening flags as well, please report them.
 
 If there's no output, no flags are missing and the build log is fine.
 
+See F<README> for details about performed checks, auto-detection and
+limitations.
+
 =head1 OPTIONS
 
 =over 8