Bump version to 1.2

Added a version upgrade helper
Farigh · Mar 14, 2021 · 590d720 · 590d720
1 parent ab8e764
commit 590d720
Show file tree

Hide file tree

Showing 36 changed files with 178 additions and 34 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,11 @@ All notable changes to the Memcheck-Cover project will be documented in this fil
 
 ## [Unreleased](https://github.com/Farigh/memcheck-cover/tree/HEAD)
 
-[Full Changelog](https://github.com/Farigh/memcheck-cover/compare/release-1.1...HEAD)
+[Full Changelog](https://github.com/Farigh/memcheck-cover/compare/release-1.2...HEAD)
+
+## [v1.2](https://github.com/Farigh/memcheck-cover/releases/tag/release-1.2) (2021-03-14)
+
+[Full Changelog](https://github.com/Farigh/memcheck-cover/compare/release-1.1...release-1.2)
 
 **New features:**
   - Add support for Valgrind's `--fullpath-after` option to the `memcheck_runner.sh` script
@@ -149,4 +153,4 @@ The `generate_html_report.sh` script highlights the following elements:
     - Address 0x[0-9a-fA-F]+ is in the .\* segment of
     - Address 0x[0-9a-fA-F]+ is in the brk data segment
     - Address 0x[0-9a-fA-F]+ is .\* bytes after the brk data segment limit
-    - Address 0x[0-9a-fA-F]+ is in a .\* segment
+    - Address 0x[0-9a-fA-F]+ is in a .\* segment
diff --git a/README.md b/README.md
@@ -270,7 +270,7 @@ memcheck_url_prefix_replacement_type["<path_prefix>"]="<repository_type>"
 
 Where the key `path_prefix` is the file path prefix to the repository root directory.
 
-The value `repository_url_prefix` is the source control server prefix to the repository.
+The value `repository_url_prefix` is the source control server prefix to the repository.\
 Here are some example:
   - Github: https://github.com/example/example_project/blob/master/
   - GitLab: https://gitlab.com/example/example_project/-/blob/master/
@@ -281,7 +281,7 @@ And the value `repository_type` is one of the supported server type (case does n
   - GitLab
   - BitBucket
 
-:warning: It's advised to set a link pointing to a specific commit sha1 instead of a branch so the links would always points to a meaningful line.
+:warning: It's advised to set a link pointing to a specific commit sha1 instead of a branch so that the report's links would always point to a meaningful line.
 
 For example, setting:
 ```shell
@@ -298,3 +298,5 @@ To:
 ```
 ==1==    at 0x10101042: myFunc() (<a href="https://github.com/example/example_project/blob/master/src/lib1/MyClass.cpp#L14">/var/user/repo/src/lib1/MyClass.cpp:14</a>)
 ```
+
+Multiple replacements can be defined
diff --git a/bin/utils.common.sh b/bin/utils.common.sh
@@ -47,7 +47,7 @@ function info()
 
 function get_memcheck_cover_version()
 {
-    echo "1.1"
+    echo "1.2"
 }
 
 function print_copyright_notice()
@@ -75,6 +75,7 @@ function require_bin_or_die()
         exit 1
     fi
 }
+
 function check_param()
 {
     local opt_name=$1

diff --git a/tests/generate_html_outputs_ts/ref/combined_path_substitution_and_url_link_report/index.html b/tests/generate_html_outputs_ts/ref/combined_path_substitution_and_url_link_report/index.html
@@ -43,7 +43,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/definitely_lost_report/index.html b/tests/generate_html_outputs_ts/ref/definitely_lost_report/index.html
@@ -39,7 +39,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/fishy_argument_value_report/index.html b/tests/generate_html_outputs_ts/ref/fishy_argument_value_report/index.html
@@ -39,7 +39,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/illegal_memory_pool_addr_report/index.html b/tests/generate_html_outputs_ts/ref/illegal_memory_pool_addr_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/indirectly_lost_report/index.html b/tests/generate_html_outputs_ts/ref/indirectly_lost_report/index.html
@@ -39,7 +39,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/invalid_delete_report/index.html b/tests/generate_html_outputs_ts/ref/invalid_delete_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/invalid_read_report/index.html b/tests/generate_html_outputs_ts/ref/invalid_read_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/invalid_write_report/index.html b/tests/generate_html_outputs_ts/ref/invalid_write_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/jump_to_invalid_addr_report/index.html b/tests/generate_html_outputs_ts/ref/jump_to_invalid_addr_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/many_result_report/index.html b/tests/generate_html_outputs_ts/ref/many_result_report/index.html
@@ -194,7 +194,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/mismatched_delete_report/index.html b/tests/generate_html_outputs_ts/ref/mismatched_delete_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/no_error_report/index.html b/tests/generate_html_outputs_ts/ref/no_error_report/index.html
@@ -38,7 +38,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/overlapping_blocks_report/index.html b/tests/generate_html_outputs_ts/ref/overlapping_blocks_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/overlapping_src_dest_report/index.html b/tests/generate_html_outputs_ts/ref/overlapping_src_dest_report/index.html
@@ -39,7 +39,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/path_prefix_substitution/deletion_report/index.html b/tests/generate_html_outputs_ts/ref/path_prefix_substitution/deletion_report/index.html
@@ -43,7 +43,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/...tml_outputs_ts/ref/path_prefix_substitution/with_substitution_backquote_report/index.html b/...tml_outputs_ts/ref/path_prefix_substitution/with_substitution_backquote_report/index.html
@@ -43,7 +43,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/...tml_outputs_ts/ref/path_prefix_substitution/with_substitution_backslash_report/index.html b/...tml_outputs_ts/ref/path_prefix_substitution/with_substitution_backslash_report/index.html
@@ -43,7 +43,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/...tml_outputs_ts/ref/path_prefix_substitution/with_substitution_lt_and_gt_report/index.html b/...tml_outputs_ts/ref/path_prefix_substitution/with_substitution_lt_and_gt_report/index.html
@@ -43,7 +43,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/path_url_link_generation_report/index.html b/tests/generate_html_outputs_ts/ref/path_url_link_generation_report/index.html
@@ -43,7 +43,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/possibly_lost_report/index.html b/tests/generate_html_outputs_ts/ref/possibly_lost_report/index.html
@@ -39,7 +39,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/still_reachable_report/index.html b/tests/generate_html_outputs_ts/ref/still_reachable_report/index.html
@@ -39,7 +39,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/...generate_html_outputs_ts/ref/syscall_param_contains_uninitialized_bytes_report/index.html b/...generate_html_outputs_ts/ref/syscall_param_contains_uninitialized_bytes_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/...enerate_html_outputs_ts/ref/syscall_param_points_to_uninitialized_bytes_report/index.html b/...enerate_html_outputs_ts/ref/syscall_param_points_to_uninitialized_bytes_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/unaddressable_bytes_report/index.html b/tests/generate_html_outputs_ts/ref/unaddressable_bytes_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/uninitialized_value_report/index.html b/tests/generate_html_outputs_ts/ref/uninitialized_value_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/valgrind_client_checks_report/index.html b/tests/generate_html_outputs_ts/ref/valgrind_client_checks_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/valgrind_warnings_report/index.html b/tests/generate_html_outputs_ts/ref/valgrind_warnings_report/index.html
@@ -39,7 +39,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/violation_context_report/index.html b/tests/generate_html_outputs_ts/ref/violation_context_report/index.html
@@ -69,7 +69,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tests/generate_html_outputs_ts/ref/violation_suppression_report/index.html b/tests/generate_html_outputs_ts/ref/violation_suppression_report/index.html
@@ -41,7 +41,7 @@
             </div>
             <div class="report_footer">
                 <div class="generation_tool_version">
-                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.1
+                    This report was generated using <a href="https://github.com/Farigh/memcheck-cover">memcheck-cover</a> v1.2
                 </div>
             </div>
         </div>

diff --git a/tools/awk/update_version.awk b/tools/awk/update_version.awk
@@ -0,0 +1,33 @@
+#! /usr/bin/gawk -f
+
+#####
+##
+## This script is a helper to increment the release version number
+##
+#####
+
+BEGIN {
+    in_version_func = 0
+}
+
+# Version function declaration
+/^function get_memcheck_cover_version\(\)$/ {
+    in_version_func = 1
+}
+
+# Version function closing brace
+/^}$/ {
+    in_version_func = 0
+}
+
+{
+    current_line = $0
+
+    if (in_version_func == 1) {
+        # Update version
+        current_line = gensub(/echo "[0-9]+\.[0-9]+"/, "echo \"" new_version "\"", 1, current_line)
+    }
+
+    # Print the current line
+    print current_line
+}
diff --git a/tools/awk/update_version_in_changelog.awk b/tools/awk/update_version_in_changelog.awk
@@ -0,0 +1,25 @@
+#! /usr/bin/gawk -f
+
+#####
+##
+## This script is a helper to increment the release version number
+##
+#####
+
+{
+    if ($0 ~ /\[Full Changelog\]\(https:\/\/github\.com\/Farigh\/memcheck-cover\/compare\/release-[0-9]+.[0-9]+\.\.\.HEAD\)/) {
+        current_date = strftime("%Y-%m-%d")
+
+        # Update unreleased changes compare link
+        print "[Full Changelog](https://github.com/Farigh/memcheck-cover/compare/release-" new_version "...HEAD)"
+        print ""
+
+        # Add new version header
+        print "## [v" new_version "](https://github.com/Farigh/memcheck-cover/releases/tag/release-" new_version ") (" current_date ")"
+        print ""
+        # Add new version changes compare link
+        print gensub(/HEAD/, "release-" new_version, 1, $0)
+    } else {
+        print $0
+    }
+}
diff --git a/tools/awk/update_version_in_test_refs.awk b/tools/awk/update_version_in_test_refs.awk
@@ -0,0 +1,16 @@
+#! /usr/bin/gawk -f
+
+#####
+##
+## This script is a helper to increment the release version number
+##
+#####
+
+{
+    if ($0 ~ /This report was generated using/) {
+        print gensub(/v[0-9]+.[0-9]+/, "v" new_version, 1)
+    } else {
+        # Print the current line
+        print $0
+    }
+}