jackrabbit-oak-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Angela Schreiber <anch...@adobe.com>
Subject MK API: consistent usage of revision, revision id, revision number [...]
Date Fri, 13 Apr 2012 10:18:45 GMT

just found in the mk API that the usage of revision isn't
completely consistent:

- 'revision number'
    -> revision id was probably more appropriate

- 'revision' when referring to a String
    -> i would suggest to use again 'revision id'

and consequently only use 'revision' when really referring
to the revision.

example: MicroKernel#getHeadRevision String
          MicroKernel#waitForCommit (fixed in rev. 1325699)

- there are cases where the API/javadoc refers to a revision
   but in fact it means some sort of revision-info that
   consists of revisionID + time stamp

example: MicroKernel#getRevisions, javadoc of #getJournal

what do you think? was this worth being addressed?


View raw message