Skip to content

Commit 3495601

Browse files
Andrew Haleyjonathan-gibbons
authored andcommitted
7903866: apidiff: add an example to the doc
Reviewed-by: jjg
1 parent 01d14ee commit 3495601

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/share/doc/apidiff.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,3 +509,20 @@ The tool does _not_ attempt to run `javadoc` locally to generate the page on the
509509
[jdk.compiler]: https://docs.oracle.com/en/java/javase/17/docs/api/jdk.compiler/module-summary.html
510510
[Java Language Model API]: https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/lang/model/package-summary.html
511511
[Compiler Tree API]: https://docs.oracle.com/en/java/javase/17/docs/api/jdk.compiler/com/sun/source/doctree/package-summary.html
512+
513+
## Example
514+
515+
To compare APIs in the `java.base` module in JDK builds `/local/baseline-jdk` and `/local/updated-jdk`, and place the result in the directory `out`, run the following command:
516+
517+
```
518+
bin/apidiff \
519+
--api jdk \
520+
--jdk-build /local/baseline-jdk/build/linux-x86_64-server-fastdebug \
521+
--api sv \
522+
--jdk-build /local/updated-jdk/build/linux-x86_64-server-fastdebug \
523+
--jdk-docs docs \
524+
-d out \
525+
--compare-api-descriptions true \
526+
--include 'java.base/**'
527+
```
528+

0 commit comments

Comments
 (0)