Merge pull request #445 from williamdes/fixups

Documentation improvements and drop debian/

.github/workflows/ci.yml

@@ -123,6 +123,7 @@ jobs:
         # - linux/arm/v7
         # - linux/arm64/v8
         # - linux/ppc64le
+        # - linux/mips64le
         # - linux/riscv64
         # - linux/s390x
         # Does not build:

.github/workflows/release.yml

@@ -75,6 +75,7 @@ jobs:
           # - linux/arm/v7
           # - linux/arm64/v8
           # - linux/ppc64le
+          # - linux/mips64le
           # - linux/riscv64
           # - linux/s390x
           # Does not build:

Dockerfile

@@ -57,6 +57,7 @@ RUN set -eux; \
     # Make assertions
     grep -q -c '"percent_covered": "100.00"' /tmp/coverage/test-executable.sh/coverage.json; \
     grep -q -c '"total_lines": 2' /tmp/coverage/test-executable.sh/coverage.json; \
+    kcov --help --uncommon-options; \
     # Cleanup
     rm -r /tmp/coverage /tmp/test-executable.sh;
 

doc/codecov.md

@@ -1,15 +1,15 @@
 Travis-ci / codecov integration
 ---------------------------------
-Integrating with [codecov](http://codecov.io) is easy to do. To upload data from the travis build to codecov, run kcov normally, and then upload using the codecov uploader
+Integrating with [codecov](https://codecov.io) is easy to do. To upload data from the travis build to codecov, run kcov normally, and then upload using the codecov uploader
 
-```
+```sh
 kcov /path/to/outdir executable
 bash <(curl -s https://codecov.io/bash) -s /path/to/outdir
 ```
 
 The easiest way to achieve this is to run the codecov uploader on travis success:
 
-```
+```yml
 after_success:
   - bash <(curl -s https://codecov.io/bash) -s /path/to/outdir
 ```

doc/coveralls.md

@@ -1,10 +1,10 @@
 Travis-ci / coveralls integration
 ---------------------------------
-kcov is easy to integrate with [travis-ci](http://travis-ci.org) and
-[coveralls.io](http://coveralls.io). To upload data from the travis build to coveralls,
+kcov is easy to integrate with [travis-ci](https://www.travis-ci.com/) and
+[coveralls.io](https://coveralls.io). To upload data from the travis build to coveralls,
 run kcov with
 
-```
+```sh
 kcov --coveralls-id=$TRAVIS_JOB_ID /path/to/outdir executable
 ```
 

doc/full-system-instrumentation.md

@@ -15,7 +15,7 @@ Instrumenting binaries for a target system
 ------------------------------------------
 If your binaries (with debug symbols) are in e.g., sysroot, you can instrument binaries using
 
-```
+```sh
 kcov-system --system-record /tmp/out-sysroot sysroot
 ```
 

doc/jenkins.md

@@ -1,6 +1,6 @@
 Integration with Jenkins
 ------------------------
 Kcov also outputs data in the Cobertura XML format, which allows integrating kcov
-output in Jenkins (see http://cobertura.sf.net and http://jenkins-ci.org).
+output in Jenkins (see https://cobertura.github.io/cobertura/ and https://www.jenkins.io/).
 
 The Cobertura output is placed in a file named ```out-path/exec-filename/cobertura.xml```

doc/kcov.1

@@ -2,7 +2,7 @@
 .\" First parameter, NAME, should be all caps
 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 .\" other parameters are allowed: see man(7), man(1)
-.TH KCOV 1 "November  24, 2011"
+.TH KCOV 1 "July  8, 2024"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -19,7 +19,7 @@
 kcov \- Code coverage analysis for compiled programs and Python scripts
 .SH SYNOPSIS
 .B kcov
-.RI [ options ] " outdir executable [args-for-executable...]
+.RI [ options ] " out-dir in-file [args-for-executable...]
 .PP
 .B kcov
 .RI --merge " outdir <path-to-coverage> [path-to-more-coverage...]
@@ -41,7 +41,7 @@ Trace PID instead of executing executable (passing the executable is optional
 for this case). Under this mode, coverage collection for shared libraries will not work.
 .TP
 \fB\-l\fP, \fB\-\-limits\fP=\fIlow,high\fP
-Setup limits for low/high coverage (default: 16,50).
+Setup limits for low/high coverage (default: 25,75).
 .TP
 \fB\-\-include\-path\fP=\fIP1\fP[\fI,P2\fP...]
 Comma-separated list of paths to include in the report.
@@ -61,6 +61,9 @@ Comma-separated list of line patterns to exclude (mark as non-code)
 \fB\-\-exclude\-region\fP=\fISTART:END\fP[\fI,START1:END1\fP...]
 Comma-separated list of regions of lines patterns to exclude (mark as non-code). The region begins with START and ends with END.
 .TP
+\fB\-\-clean
+Don't accumulate data from multiple runs.
+.TP
 \fB\-\-collect\-only
 Only collect coverage data, don't produce HTML/Cobertura output.
 .TP
@@ -73,6 +76,9 @@ Merge the result of multiple kcov runs. Instead of a program to test, the output
 \fB\-\-coveralls\-id\fP=\fIid\fP
 Upload data to coveralls.io using secret repo_token or Travis CI service job ID \fIid\fP.
 The ID is taken as a repo_token if it's longer or equal to 32 characters.
+.TP
+\fB\-\-strip\-path\fP=\fIpath\fP
+If not set, max common path will be stripped away.
 .SH UNCOMMON OPTIONS
 .TP
 \fB\-\-path\-strip\-level\fP=\fIN\fP
@@ -160,7 +166,7 @@ share a subset of source files.
 .SH COBERTURA OUTPUT
 .PP
 Kcov also outputs data in the Cobertura XML format, which allows integrating kcov
-output in Jenkins (see http://cobertura.sf.net and http://jenkins-ci.org).
+output in Jenkins (see https://cobertura.github.io/cobertura/ and https://www.jenkins.io/).
 .PP
 The Cobertura output is placed in a file named out-path/exec-filename/cobertura.xml.
 .SH JSON OUTPUT

src/CMakeLists.txt

@@ -44,7 +44,7 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 set (KCOV kcov)
 
 
-# See http://eatmyrandom.blogspot.se/2010/06/automate-version-numbering-using-git.html
+# See https://eatmyrandom.blogspot.com/2010/06/automate-version-numbering-using-git.html
 if (EXISTS "${CMAKE_SOURCE_DIR}/.git")
     find_program (GIT_EXECUTABLE NAMES git)
     if (GIT_EXECUTABLE)
@@ -57,6 +57,7 @@ if (EXISTS "${CMAKE_SOURCE_DIR}/.git")
             "--git-dir=${CMAKE_SOURCE_DIR}/.git"
             describe
             --abbrev=4
+            --tags
             HEAD
         OUTPUT_VARIABLE POD_VERSION
         OUTPUT_STRIP_TRAILING_WHITESPACE