From 48f30b8614cb174256c2cb4d5d25a5bf35464fec Mon Sep 17 00:00:00 2001 From: Tomasz Zarna Date: Wed, 20 Mar 2013 23:48:34 +0100 Subject: [PATCH] Fix @since tags in JGit, version 2.4 never existed Change-Id: Iaca88ec28b412e6b58e7b39a0762ba54b25f9471 Signed-off-by: Matthias Sohn --- org.eclipse.jgit.pgm/.settings/.api_filters | 10 ++++++++++ org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java | 2 +- .../src/org/eclipse/jgit/api/NameRevCommand.java | 4 +++- .../org/eclipse/jgit/errors/NoMergeBaseException.java | 2 ++ ...toredObjectRepresentationNotAvailableException.java | 1 + .../src/org/eclipse/jgit/lib/BitmapIndex.java | 6 +++++- .../src/org/eclipse/jgit/lib/BitmapObject.java | 6 +++++- .../src/org/eclipse/jgit/lib/ConfigConstants.java | 5 ++++- .../src/org/eclipse/jgit/lib/CoreConfig.java | 2 +- .../src/org/eclipse/jgit/lib/ObjectReader.java | 2 ++ .../src/org/eclipse/jgit/lib/RepositoryState.java | 2 +- .../src/org/eclipse/jgit/merge/StrategyRecursive.java | 2 ++ .../src/org/eclipse/jgit/revwalk/RevFlag.java | 2 ++ .../jgit/storage/file/FileRepositoryBuilder.java | 1 + .../eclipse/jgit/storage/file/WindowCacheConfig.java | 3 +++ .../src/org/eclipse/jgit/storage/pack/PackConfig.java | 5 ++++- .../org/eclipse/jgit/transport/UploadPackLogger.java | 1 + .../src/org/eclipse/jgit/util/FileUtils.java | 3 ++- org.eclipse.jgit/src/org/eclipse/jgit/util/NB.java | 1 + 19 files changed, 51 insertions(+), 9 deletions(-) create mode 100644 org.eclipse.jgit.pgm/.settings/.api_filters diff --git a/org.eclipse.jgit.pgm/.settings/.api_filters b/org.eclipse.jgit.pgm/.settings/.api_filters new file mode 100644 index 000000000..5e044ee2a --- /dev/null +++ b/org.eclipse.jgit.pgm/.settings/.api_filters @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java index d36b9bede..4b8378aea 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java @@ -636,7 +636,7 @@ public class Git { * Returns a command object to find human-readable names of revisions. * * @return a {@link NameRevCommand}. - * @since 2.3 + * @since 3.0 */ public NameRevCommand nameRev() { return new NameRevCommand(repo); diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/NameRevCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/NameRevCommand.java index fcc02c7fe..4789fbe93 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/NameRevCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/NameRevCommand.java @@ -68,8 +68,10 @@ import org.eclipse.jgit.revwalk.RevWalk; /** * Command to find human-readable names of revisions. * - * @see Git documentation about name-rev + * @since 3.0 */ public class NameRevCommand extends GitCommand> { /** Amount of slop to allow walking past the earliest requested commit. */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/errors/NoMergeBaseException.java b/org.eclipse.jgit/src/org/eclipse/jgit/errors/NoMergeBaseException.java index df90e6900..0c419d759 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/errors/NoMergeBaseException.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/errors/NoMergeBaseException.java @@ -51,6 +51,8 @@ import org.eclipse.jgit.merge.RecursiveMerger; /** * Exception thrown if a merge fails because no merge base could be determined. + * + * @since 3.0 */ public class NoMergeBaseException extends IOException { private static final long serialVersionUID = 1L; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/errors/StoredObjectRepresentationNotAvailableException.java b/org.eclipse.jgit/src/org/eclipse/jgit/errors/StoredObjectRepresentationNotAvailableException.java index 395578ef2..0bd035b5d 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/errors/StoredObjectRepresentationNotAvailableException.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/errors/StoredObjectRepresentationNotAvailableException.java @@ -54,6 +54,7 @@ public class StoredObjectRepresentationNotAvailableException extends Exception { * * @param otp * the object whose current representation is no longer present. + * @since 3.0 */ public StoredObjectRepresentationNotAvailableException(ObjectToPack otp) { // Do nothing. diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/BitmapIndex.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/BitmapIndex.java index 9b6f0a303..3c0e2c128 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/BitmapIndex.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/BitmapIndex.java @@ -47,7 +47,11 @@ import java.util.Iterator; import org.eclipse.jgit.internal.storage.file.PackBitmapIndex; -/** A compressed bitmap representation of the entire object graph. */ +/** + * A compressed bitmap representation of the entire object graph. + * + * @since 3.0 + */ public interface BitmapIndex { /** * Get the bitmap for the id. The returned bitmap is immutable and the diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/BitmapObject.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/BitmapObject.java index ba7ed648d..345016c17 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/BitmapObject.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/BitmapObject.java @@ -43,7 +43,11 @@ package org.eclipse.jgit.lib; -/** Base object type accessed during bitmap expansion. */ +/** + * Base object type accessed during bitmap expansion. + * + * @since 3.0 + */ public abstract class BitmapObject { /** * Get Git object type. See {@link Constants}. diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigConstants.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigConstants.java index 88d274147..2c2cef3f5 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigConstants.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigConstants.java @@ -196,6 +196,9 @@ public class ConfigConstants { /** The "ff" key */ public static final String CONFIG_KEY_FF = "ff"; - /** The "checkstat" key */ + /** + * The "checkstat" key + * @since 3.0 + */ public static final String CONFIG_KEY_CHECKSTAT = "checkstat"; } diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/CoreConfig.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/CoreConfig.java index 982cbc84e..0fc3d4ad0 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/CoreConfig.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/CoreConfig.java @@ -77,7 +77,7 @@ public class CoreConfig { /** * Permissible values for {@code core.checkstat} * - * @since 2.3 + * @since 3.0 */ public static enum CheckStat { /** diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectReader.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectReader.java index fae92fe14..3bd02500c 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectReader.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectReader.java @@ -444,6 +444,7 @@ public abstract class ObjectReader { * * @param avoid * true to avoid unreachable objects. + * @since 3.0 */ public void setAvoidUnreachableObjects(boolean avoid) { // Do nothing by default. @@ -455,6 +456,7 @@ public abstract class ObjectReader { * @return the index or null if one does not exist. * @throws IOException * when the index fails to load + * @since 3.0 */ public BitmapIndex getBitmapIndex() throws IOException { return null; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/RepositoryState.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/RepositoryState.java index 233856d74..4fac2ebed 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/RepositoryState.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/RepositoryState.java @@ -400,7 +400,7 @@ public enum RepositoryState { /** * @return true if the repository is currently in a rebase - * @since 2.4 + * @since 3.0 */ public abstract boolean isRebasing(); diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/merge/StrategyRecursive.java b/org.eclipse.jgit/src/org/eclipse/jgit/merge/StrategyRecursive.java index 11c8bca5d..58c1ed22d 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/merge/StrategyRecursive.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/merge/StrategyRecursive.java @@ -47,6 +47,8 @@ import org.eclipse.jgit.lib.Repository; /** * A three-way merge strategy performing a content-merge if necessary + * + * @since 3.0 */ public class StrategyRecursive extends StrategyResolve { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevFlag.java b/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevFlag.java index c767c033e..8068ba6e1 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevFlag.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevFlag.java @@ -73,6 +73,8 @@ public class RevFlag { * queue, especially if we reached it by more than one path. *

* This is a static flag. Its RevWalk is not available. + * + * @since 3.0 */ public static final RevFlag SEEN = new StaticRevFlag("SEEN", RevWalk.SEEN); diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/FileRepositoryBuilder.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/FileRepositoryBuilder.java index 60c916ebc..5efa2507a 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/FileRepositoryBuilder.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/FileRepositoryBuilder.java @@ -85,6 +85,7 @@ public class FileRepositoryBuilder extends * @throws IOException * the repository could not be accessed to configure the rest of * the builder's parameters. + * @since 3.0 */ @Override public Repository build() throws IOException { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/WindowCacheConfig.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/WindowCacheConfig.java index 8ed2af117..69abd0d97 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/WindowCacheConfig.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/WindowCacheConfig.java @@ -189,6 +189,7 @@ public class WindowCacheConfig { * @param rc * configuration to read properties from. * @return {@code this}. + * @since 3.0 */ public WindowCacheConfig fromConfig(final Config rc) { setPackedGitOpenFiles(rc.getInt( @@ -217,6 +218,8 @@ public class WindowCacheConfig { * The new configuration is applied immediately. If the new limits are * smaller than what what is currently cached, older entries will be purged * as soon as possible to allow the cache to meet the new limit. + * + * @since 3.0 */ public void install() { WindowCache.reconfigure(this); diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/PackConfig.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/PackConfig.java index 7559e907e..562b2c0a2 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/PackConfig.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/PackConfig.java @@ -53,7 +53,7 @@ import org.eclipse.jgit.lib.Repository; /** * Configuration used by a pack writer when constructing the stream. - * + * * A configuration may be modified once created, but should not be modified * while it is being used by a PackWriter. If a configuration is not modified it * is safe to share the same configuration instance between multiple concurrent @@ -134,6 +134,7 @@ public class PackConfig { * Default value of the build bitmaps option: {@value} * * @see #setBuildBitmaps(boolean) + * @since 3.0 */ public static final boolean DEFAULT_BUILD_BITMAPS = true; @@ -631,6 +632,7 @@ public class PackConfig { * * @return true if delta base is the writer can choose to output an index * with bitmaps. + * @since 3.0 */ public boolean isBuildBitmaps() { return buildBitmaps; @@ -646,6 +648,7 @@ public class PackConfig { * @param buildBitmaps * boolean indicating whether bitmaps may be included in the * index. + * @since 3.0 */ public void setBuildBitmaps(boolean buildBitmaps) { this.buildBitmaps = buildBitmaps; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPackLogger.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPackLogger.java index 74dfa6ce5..99fa6e02b 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPackLogger.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPackLogger.java @@ -66,6 +66,7 @@ public interface UploadPackLogger { * * @param stats * the statistics after sending a pack to the client. + * @since 3.0 */ public void onPackStatistics(PackWriter.Statistics stats); } diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java index acc1a2c31..dc0bbcb38 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java @@ -87,7 +87,7 @@ public class FileUtils { * Option to only delete empty directories. This option can be combined with * {@link #RECURSIVE} * - * @since 2.4 + * @since 3.0 */ public static final int EMPTY_DIRECTORIES_ONLY = 16; @@ -180,6 +180,7 @@ public class FileUtils { * the new {@code File} * @throws IOException * if the rename has failed + * @since 3.0 */ public static void rename(final File src, final File dst) throws IOException { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/NB.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/NB.java index 5a56a0621..e110c1142 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/NB.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/NB.java @@ -112,6 +112,7 @@ public final class NB { * position and the next 7 bytes after it (for a total of 8 * bytes) will be read. * @return signed integer value that matches the 64 bits read. + * @since 3.0 */ public static long decodeInt64(final byte[] intbuf, final int offset) { long r = intbuf[offset] << 8;