[hibernate-issues] [Hibernate-JIRA] Commented: (HV-417) Add section on public API and it's changes to the reference guide

[Gunnar Morling (JIRA)]

    [ http://opensource.atlassian.com/projects/hibernate/browse/HV-417?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=39664#action_39664 ] 

Gunnar Morling commented on HV-417:
-----------------------------------

I ran JDiff manually, but probably this can be automated in some way. The biggest problem will be that the previous API version needs to available during generation of the report. So one would probably have to check out the appropriate tag from Git or similar.

Another option might be [clirr|http://clirr.sourceforge.net/], which for instance is used for generating [sl4j's compatibility report|http://www.slf4j.org/compatibility.html]. The output seems very compact and focused on the compatibility aspect. I'll try it out and report on the results.

> Add section on public API and it's changes to the reference guide
> -----------------------------------------------------------------
>
>                 Key: HV-417
>                 URL: http://opensource.atlassian.com/projects/hibernate/browse/HV-417
>             Project: Hibernate Validator
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Gunnar Morling
>            Assignee: Gunnar Morling
>             Fix For: 4.2.0.Beta2
>
>
> The reference guide should make clear, which HV packages are public and which ones not. Also some rules for evolvement of the public packages should be specified. 
> The packages comprising the programmatic configuration API should be part of the generated OSGi manifest.
> This is a follow-up to HV-310.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://opensource.atlassian.com/projects/hibernate/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira