diff --git a/java/com/google/gerrit/acceptance/UseLocalDisk.java b/java/com/google/gerrit/acceptance/UseLocalDisk.java index e177bb41ba..192caa0520 100644 --- a/java/com/google/gerrit/acceptance/UseLocalDisk.java +++ b/java/com/google/gerrit/acceptance/UseLocalDisk.java @@ -21,6 +21,15 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; import java.lang.annotation.Retention; import java.lang.annotation.Target; +/** + * Annotation to mark tests that require a local disk for the execution. + * + *

Tests that do not have this annotation are executed in memory. + * + *

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 550914020e..12a99773c7 100644 --- a/java/com/google/gerrit/acceptance/UseSsh.java +++ b/java/com/google/gerrit/acceptance/UseSsh.java @@ -21,6 +21,14 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; import java.lang.annotation.Retention; import java.lang.annotation.Target; +/** + * Annotation to mark SSH tests. + * + *

When running tests the SSH functionality is disabled unless the {@link UseSsh} annotation is + * used. + * + *

SSH tests can be skipped when executing tests (see {@link com.google.gerrit.testing.SshMode}). + */ @Target({TYPE, METHOD}) @Retention(RUNTIME) public @interface UseSsh {}