Commit 5c88544
authored
docs(java-dedup): clarify pom.xml changes are optional (#856)
* docs(java-dedup): clarify pom.xml changes are optional
- Empirically verified that the Java dedup agent is a pure -javaagent
(Premain-Class only, Can-Redefine-Classes=false,
Can-Retransform-Classes=false), so it does not modify application
bytecode at compile time or retransform at load time. No source-code
or pom.xml changes are required to enable dedup.
- Restructured the "Pre-requisite" section to lead with the runtime-only
requirement (both agent JARs available on disk for -javaagent:) and
present three equivalent ways to obtain the JARs:
A. mvn dependency:copy (no pom edit)
B. direct curl from Maven Central (no Maven required)
C. existing maven-dependency-plugin block in pom.xml (now framed as
optional convenience)
- Verified end-to-end with samples-java/java-dedup: built with
unmodified pom.xml, fetched keploy-sdk.jar via mvn dependency:copy,
ran keploy test --dedup against 400 testcases (400/400 passed),
keploy dedup produced duplicates.yaml with 18 unique / 381 duplicate.
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
* docs(java-dedup): fix Vale lint errors and Option B mkdir step
- Reword "retransform classes at load time" to "while classes load" to
avoid the Vale.Spelling false positive on "retransform" while keeping
the meaning intact.
- Replace four em-dashes that had surrounding spaces (Google.EmDash) in
the Option A/B/C labels and the Option C explanation. Use a comma for
the labels and a semicolon mid-sentence in Option C.
- Address Copilot review: prepend `mkdir -p target` to Option B so the
curl commands work on a fresh checkout (target/ would not exist yet
before the application is built).
- Verified locally: vale on the changed file reports 0 errors,
0 warnings, 0 suggestions.
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
* docs(java-dedup): streamline deduplication instructions and remove redundant notes
- Simplified language around the Java agent's bytecode modification,
clarifying that no source code or `pom.xml` changes are necessary
for deduplication.
- Removed unnecessary emphasis on the `-javaagent:` requirement and
streamlined the instructions for fetching the required JARs.
- Updated the formatting of the Option A section for clarity.
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
* docs(java-dedup): minor formatting adjustments in deduplication instructions
- Fixed spacing inconsistencies in the Java deduplication
documentation, particularly around the `-javaagent:` requirement
and the Option A section.
- Ensured clarity and consistency in the presentation of instructions
without altering the content.
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
---------
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>1 parent 8d2ffb4 commit 5c88544
1 file changed
Lines changed: 29 additions & 1 deletion
Lines changed: 29 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
123 | 123 | | |
124 | 124 | | |
125 | 125 | | |
126 | | - | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
127 | 155 | | |
128 | 156 | | |
129 | 157 | | |
| |||
0 commit comments