Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements and drop debian/ #445

Merged
merged 6 commits into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ jobs:
# - linux/arm/v7
# - linux/arm64/v8
# - linux/ppc64le
# - linux/mips64le
# - linux/riscv64
# - linux/s390x
# Does not build:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ jobs:
# - linux/arm/v7
# - linux/arm64/v8
# - linux/ppc64le
# - linux/mips64le
# - linux/riscv64
# - linux/s390x
# Does not build:
Expand Down
1 change: 1 addition & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
3 changes: 0 additions & 3 deletions debian/.gitignore

This file was deleted.

6 changes: 0 additions & 6 deletions debian/README

This file was deleted.

5 changes: 0 additions & 5 deletions debian/changelog

This file was deleted.

1 change: 0 additions & 1 deletion debian/compat

This file was deleted.

19 changes: 0 additions & 19 deletions debian/control

This file was deleted.

34 changes: 0 additions & 34 deletions debian/copyright

This file was deleted.

3 changes: 0 additions & 3 deletions debian/kcov-docs.docs

This file was deleted.

25 changes: 0 additions & 25 deletions debian/rules

This file was deleted.

1 change: 0 additions & 1 deletion debian/source/format

This file was deleted.

6 changes: 3 additions & 3 deletions doc/codecov.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand Down
6 changes: 3 additions & 3 deletions doc/coveralls.md
Original file line number Diff line number Diff line change
@@ -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
```

Expand Down
2 changes: 1 addition & 1 deletion doc/full-system-instrumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
2 changes: 1 addition & 1 deletion doc/jenkins.md
Original file line number Diff line number Diff line change
@@ -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```
14 changes: 10 additions & 4 deletions doc/kcov.1
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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...]
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -57,6 +57,7 @@ if (EXISTS "${CMAKE_SOURCE_DIR}/.git")
"--git-dir=${CMAKE_SOURCE_DIR}/.git"
describe
--abbrev=4
--tags
SimonKagstrom marked this conversation as resolved.
Show resolved Hide resolved
HEAD
OUTPUT_VARIABLE POD_VERSION
OUTPUT_STRIP_TRAILING_WHITESPACE
Expand Down
Loading