From: Simon Ruderich <simon@ruderich.org>
Date: Wed, 14 Aug 2013 13:14:53 +0000 (+0200)
Subject: Minor source documentation update.
X-Git-Tag: 0.05~26
X-Git-Url: https://ruderich.org/simon/gitweb/?p=blhc%2Fblhc.git;a=commitdiff_plain;h=4ab50053d9969464c5002db66e135bcfb92bd625

Minor source documentation update.
---

diff --git a/bin/blhc b/bin/blhc
index dc71cc1..cfe49d2 100755
--- a/bin/blhc
+++ b/bin/blhc
@@ -176,7 +176,8 @@ my $file_extension_regex = qr/
                     # terminated with "\n".
     /x;
 
-# Expected (hardening) flags. All flags are used as regexps.
+# Expected (hardening) flags. All flags are used as regexps (and compiled to
+# real regexps below for better execution speed).
 my @def_cflags = (
     '-g',
     '-O(?:2|3)',
@@ -475,6 +476,7 @@ sub is_non_verbose_build {
     return 1;
 }
 
+# Remove @flags from $flag_refs_ref, and $flag_renames_ref.
 sub remove_flags {
     my ($flag_refs_ref, $flag_renames_ref, @flags) = @_;
 
@@ -492,6 +494,7 @@ sub remove_flags {
     return;
 }
 
+# Modifies $flag_renames_ref hash.
 sub compile_flag_regexp {
     my ($flag_renames_ref, @flags) = @_;
 
@@ -510,6 +513,7 @@ sub compile_flag_regexp {
     return @result;
 }
 
+# Does any extension in @extensions exist in %{$extensions_ref}?
 sub extension_found {
     my ($extensions_ref, @extensions) = @_;
 
@@ -1023,7 +1027,8 @@ LINE:
             }
             next;
         }
-        # Even if it's a verbose build, we might have to skip this line.
+        # Even if it's a verbose build, we might have to skip this line (see
+        # is_non_verbose_build()).
         next if $skip;
 
         # Remove everything until and including the compiler command. Makes