RFR: 7903866: apidiff: add an example to the doc [v3]

[Andrew Haley]

On Tue, 22 Oct 2024 22:02:54 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> My intent is to develop a section in the doc containing real, verified examples (backed up by some form of test script.) My thought is to start with the smallest command-line for testing 2 JDK builds, and to build up from there. I'd like to illustrate that the command line is not that complicated! You should have seen it before the `--jdk-build` option was introduced.
> 
> That all being said, it will take a (short) while to develop that update, so I'll approve this example as either an interim measure or as part of what is to come.

OK, thanks. Regardless of other sections in the docs with real, verified examples, it's still a really good idea to have a few simple examples at the end of the man page. Such examples help by effectively tying the long list of options to something more concrete.

-------------

PR Comment: https://git.openjdk.org/apidiff/pull/26#issuecomment-2431583384