Skip to content

Commit 40b9dc9

Browse files
committed
remove jdiff and scripts; add documentation
1 parent 0abbbd4 commit 40b9dc9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+58
-20649
lines changed

.gitignore

-2
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,6 @@ genfiles.properties
7878
!/netbeans-plat/15
7979
/docs/doxygen-user/user-docs
8080
/docs/doxygen-dev/build-docs
81-
/jdiff-javadocs/*
82-
/jdiff-logs/*
8381
/gen_version.txt
8482
hs_err_pid*.log
8583

apidiff.py

-295
This file was deleted.
Binary file not shown.

release_scripts/APIUpdate/README.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# APIDiff
2+
3+
## Overview
4+
5+
This code can be used to determine the public API changes between the previous version of Autopsy jars to current version of Autopsy jars. Based on those changes, this code can update version numbers (release, implementation, specification, dependency version).
6+
7+
## Sample Usage & Procedure
8+
9+
1. Before starting download the nbm jar files from the [previous release](https://github.com/sleuthkit/autopsy/releases/). The jar files will be located in the zip file or the installation directory (i.e. `C:\Program Files\Autopsy-x.xx.x`) at `autopsy/modules`.
10+
2. Make sure you build the current source directory in order for the program to find the new compiled jars.
11+
3. This code can be called from this directory with a command like: `java -jar APIUpdate-1.0-jar-with-dependencies.jar -p C:\path\to\prev\vers\jars\` to get api updates.
12+
- You can specify the `-u` flag to make updates in source code making the command: `java -jar APIUpdate-1.0-jar-with-dependencies.jar -p C:\path\to\prev\vers\jars\ -u`.
13+
- You can also add ` >C:\Users\gregd\Desktop\outputdiff.txt 2>&1` to output to a file.
14+
15+
## Arguments
16+
17+
```
18+
usage: APIUpdate
19+
-c,--curr-path <path> The path to the current version jar files
20+
-cv,--curr-version <version> The current version number
21+
-p,--prev-path <path> The path to the previous version jar files
22+
-pv,--prev-version <version> The previous version number
23+
-s,--src-path <path> The path to the root of the autopsy report
24+
-u,--update Update source code versions
25+
```

release_scripts/APIUpdate/pom.xml

+2
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@
4646
<descriptorRefs>
4747
<descriptorRef>jar-with-dependencies</descriptorRef>
4848
</descriptorRefs>
49+
<!--output jar file to project root-->
50+
<outputDirectory>${project.basedir}</outputDirectory>
4951
</configuration>
5052
<executions>
5153
<execution>

0 commit comments

Comments
 (0)