Skip to content

Commit 45c998b

Browse files
committed
feat: Simplify option descriptions
1 parent 9b03963 commit 45c998b

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

docs/1_usage.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To patch an app using the default list of patches, use the `patch` command:
2424
java -jar revanced-cli.jar patch -p patches.rvp input.apk
2525
```
2626

27-
You can also use multiple files containing patches:
27+
You can also use multiple RVP files:
2828

2929
```bash
3030
java -jar revanced-cli.jar patch -p patches.rvp -b another-patches.rvp input.apk
@@ -91,13 +91,13 @@ For example, to set the options for the patch with the name `Patch name`
9191
with the key `key1` and `key2` to `value1` and `value2` respectively, use the following command:
9292

9393
```bash
94-
java -jar revanced-cli.jar patch -b patches.rvp -e "Patch name" -Okey1=value1 -Okey2=value2 input.apk
94+
java -jar revanced-cli.jar patch -p patches.rvp -e "Patch name" -Okey1=value1 -Okey2=value2 input.apk
9595
```
9696

9797
If you want to set the option value to `null`, you can omit the value:
9898

9999
```bash
100-
java -jar revanced-cli.jar patch -b revanced-patches.rvp -i "Patch name" -Okey1 input.apk
100+
java -jar revanced-cli.jar patch -p patches.rvp -i "Patch name" -Okey1 input.apk
101101
```
102102

103103
> [!WARNING]

src/main/kotlin/app/revanced/cli/command/ListCompatibleVersions.kt

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ import java.util.logging.Logger
1212
name = "list-versions",
1313
description = [
1414
"List the most common compatible versions of apps that are compatible " +
15-
"with the patches in the supplied files containing patches.",
15+
"with the patches from RVP files.",
1616
],
1717
)
1818
internal class ListCompatibleVersions : Runnable {
1919
private val logger = Logger.getLogger(this::class.java.name)
2020

2121
@CommandLine.Parameters(
22-
description = ["One or more paths to files containing patches."],
22+
description = ["Paths to RVP files."],
2323
arity = "1..*",
2424
)
2525
private lateinit var patchesFiles: Set<File>

src/main/kotlin/app/revanced/cli/command/ListPatchesCommand.kt

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ import app.revanced.patcher.patch.Option as PatchOption
1111

1212
@Command(
1313
name = "list-patches",
14-
description = ["List patches from supplied files containing patches."],
14+
description = ["List patches from supplied RVP files."],
1515
)
1616
internal object ListPatchesCommand : Runnable {
1717
private val logger = Logger.getLogger(this::class.java.name)
1818

1919
@Parameters(
20-
description = ["One or more paths to files containing patches."],
20+
description = ["Paths to RVP files."],
2121
arity = "1..*",
2222
)
2323
private lateinit var patchesFiles: Set<File>
@@ -59,7 +59,7 @@ internal object ListPatchesCommand : Runnable {
5959

6060
@Option(
6161
names = ["-i", "--index"],
62-
description = ["List the index of each patch in relation to the supplied files containing patches."],
62+
description = ["List the index of each patch in relation to the supplied RVP files."],
6363
showDefaultValue = ALWAYS,
6464
)
6565
private var withIndex: Boolean = true

src/main/kotlin/app/revanced/cli/command/PatchCommand.kt

+3-3
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ internal object PatchCommand : Runnable {
5050

5151
@CommandLine.Option(
5252
names = ["--ei"],
53-
description = ["Index of the patch in the combined list of all supplied files containing patches."],
53+
description = ["Index of the patch in the combined list of the supplied RVP files."],
5454
required = true,
5555
)
5656
internal var index: Int? = null
@@ -82,7 +82,7 @@ internal object PatchCommand : Runnable {
8282

8383
@CommandLine.Option(
8484
names = ["--di"],
85-
description = ["Index of the patch in the combined list of all supplied files containing patches."],
85+
description = ["Index of the patch in the combined list of the supplied RVP files."],
8686
required = true,
8787
)
8888
internal var index: Int? = null
@@ -200,7 +200,7 @@ internal object PatchCommand : Runnable {
200200

201201
@CommandLine.Option(
202202
names = ["-p", "--patches"],
203-
description = ["One or more path to files containing patches."],
203+
description = ["One or more path to RVP files."],
204204
required = true,
205205
)
206206
@Suppress("unused")

0 commit comments

Comments
 (0)