motiejus
/
jgit
1
Fork 0
Code Releases Activity

Add documentation explaining how to read Commit and Tag 

Since we stopped supporting these types for reading, but their
name is a natural candidate for someone to try and use in code,
explain where they should be looking instead.

Change-Id: I091a1b0ef71b842016020f938ba3161431aab9c9
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
This commit is contained in:
Shawn O. Pearce 2010-08-23 09:40:41 -07:00
parent 5fc990130b
commit 6a51d97948
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
org.eclipse.jgit/src/org/eclipse/jgit/lib/Commit.java
View File

@ -54,6 +54,10 @@
* Applications should use this object when they need to manually construct a
* commit and want precise control over its fields. For a higher level interface
* see {@link org.eclipse.jgit.api.CommitCommand}.
*
* To read a commit object, construct a {@link org.eclipse.jgit.revwalk.RevWalk}
* and obtain a {@link org.eclipse.jgit.revwalk.RevCommit} instance by calling
* {@link org.eclipse.jgit.revwalk.RevWalk#parseCommit(AnyObjectId)}.
*/
public class Commit {
private static final ObjectId[] EMPTY_OBJECTID_LIST = new ObjectId[0];

4
org.eclipse.jgit/src/org/eclipse/jgit/lib/Tag.java
View File

@ -52,6 +52,10 @@
*
* Applications should use this object when they need to manually construct a
* tag and want precise control over its fields.
*
* To read a tag object, construct a {@link org.eclipse.jgit.revwalk.RevWalk}
* and obtain a {@link org.eclipse.jgit.revwalk.RevTag} instance by calling
* {@link org.eclipse.jgit.revwalk.RevWalk#parseTag(AnyObjectId)}.
*/
public class Tag {
private ObjectId tagId;