Document UseLocalDisk and UseSsh classes Signed-off-by: Edwin Kempin <ekempin@google.com> Change-Id: Ia1b1833c766736a13ccb6a571e94089780996c9a
diff --git a/java/com/google/gerrit/acceptance/UseLocalDisk.java b/java/com/google/gerrit/acceptance/UseLocalDisk.java index e177bb4..192caa0 100644 --- a/java/com/google/gerrit/acceptance/UseLocalDisk.java +++ b/java/com/google/gerrit/acceptance/UseLocalDisk.java
@@ -21,6 +21,15 @@ import java.lang.annotation.Retention; import java.lang.annotation.Target; +/** + * Annotation to mark tests that require a local disk for the execution. + * + * <p>Tests that do not have this annotation are executed in memory. + * + * <p>Using this annotation makes the execution of the test more expensive/slower. This is why it + * should only be used if the test requires a local disk (e.g. if the test triggers the Git garbage + * collection functionality which only works with a local disk). + */ @Target({TYPE, METHOD}) @Retention(RUNTIME) public @interface UseLocalDisk {}
diff --git a/java/com/google/gerrit/acceptance/UseSsh.java b/java/com/google/gerrit/acceptance/UseSsh.java index 5509140..12a9977 100644 --- a/java/com/google/gerrit/acceptance/UseSsh.java +++ b/java/com/google/gerrit/acceptance/UseSsh.java
@@ -21,6 +21,14 @@ import java.lang.annotation.Retention; import java.lang.annotation.Target; +/** + * Annotation to mark SSH tests. + * + * <p>When running tests the SSH functionality is disabled unless the {@link UseSsh} annotation is + * used. + * + * <p>SSH tests can be skipped when executing tests (see {@link com.google.gerrit.testing.SshMode}). + */ @Target({TYPE, METHOD}) @Retention(RUNTIME) public @interface UseSsh {}