Skip to content

Commit e528653

Browse files
committed
update readme and config explanation
1 parent d2ea8a3 commit e528653

2 files changed

Lines changed: 11 additions & 16 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# JavaCallStackExtractor
1+
# JavaCallStackExtractor
22

33
JavaCallStackExtractor is a tool designed to extract as much information as possible from a Java call stack stored in a text-based file.
44
It was created to provide a parser for Java call stacks, enabling their analysis within the [Moose](https://moosetechnology.org/) software analysis platform by generating a dedicated meta-model.
@@ -17,7 +17,7 @@ Using different versions may lead to unexpected behavior.
1717
### Step 1: Launch the program you want to analyze with the following VM argument:
1818
```
1919
-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5006
20-
```
20+
```
2121

2222

2323
In Eclipse, you can add this argument in the *Run Configuration > VM Arguments* section:
@@ -31,13 +31,16 @@ This command enables debug mode on the Java VM:
3131
- address=5006: Port used to wait for debugger connection
3232

3333
### Step 2: Configure the Extractor
34-
Edit the config.json file to fit the structure of your project.
34+
Edit the configXX.json file to fit the structure of your project.
35+
A different configuration file is present for every algorithms by default.
3536
Refer to [config.md](utils/tutorials/config.md) for detailed instructions.
3637

3738
### Step 3: Run the Extractor
38-
Run either :
39+
**you can pass a path to a config file in argument if you need to keep trace of multiple configurations**
40+
Run either :
3941
- SnapshotCSExtractorLauncher : Fast, but object states are captured at the very end.
4042
- Usefull for concepts
4143
- HistoryCSExtractorLauncher : Slow, but historically accurate.
42-
- Usefull for in depth analysis
44+
- Usefull for in depth analysis
45+
4346
The output will be generated in the root directory of this repository.

utils/tutorials/config.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,8 @@
2222
],
2323
"repBefore": 0
2424
},
25-
"maxDepth" : 20,
25+
"maxObjectDepth" : 14,
2626
"logging": {
27-
"format" : "json",
2827
"outputName" : "JDIOutput",
2928
"extension": "cs"
3029

@@ -72,14 +71,7 @@ In this case:
7271
}
7372
```
7473

75-
### maxDepth
76-
Sets the maximum recursion depth for call stack logging.
74+
### maxObjectDepth
75+
Sets the maximum recursion depth of the object graph.
7776
Use a negative number for unlimited depth.
7877

79-
### logging
80-
Controls how the output is formatted and where it is saved.
81-
- format : Output format – currently supports "json"
82-
(You can easily add new formats – see [addLoggerFormat.md](addLoggerFormat.md))
83-
- outputName : Base name of the output file
84-
- extension : File extension (default is "cs").
85-
This is important for compatibility with import tools like [FamixCallStack](https://github.com/LeoDefossez/FamixCallStack#)

0 commit comments

Comments
 (0)