Skip to content

Commit 0c1821a

Browse files
committed
Adds usage, buid instruction and general info to README
1 parent ad2c0bd commit 0c1821a

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
11
# bscdiff
2-
bscdiff compares bsc, issue and CVE numbers in changelogs
2+
3+
bscdiff compares bsc, issue and CVE numbers from a source changelog, to a target changelog. Missing numbers are then printed with their occurrence in the source changelog.
4+
5+
6+
## Usage
7+
8+
```
9+
brejoc@alpha ~> ./bscdiff source.changes target.changes
10+
508: bsc#1098394 -> - Fix file.get_diff regression on 2018.3 (bsc#1098394)
11+
525: bsc#1098394 -> - Fix file.managed binary file utf8 error (bsc#1098394)
12+
4092: bsc#565656565 -> - uploaded to salt 1.12.0 (bsc#565656565, bsc#676767676)
13+
4092: bsc#676767676 -> - uploaded to salt 1.12.0 (bsc#565656565, bsc#676767676)
14+
```
15+
16+
Output is structure like this:
17+
18+
\<line in source.changes\>: \<bsc missing in target.changes\> -> \<line from source.changes\>
19+
20+
21+
## Building bscdiff
22+
23+
Since no external dependency was used, you can just do a `go build bscdiff.go`.

0 commit comments

Comments
 (0)