blob: 1e9cdf19daefb9655ad8522960948eb88aa24f07 [file] [log] [blame]
Matthias Andreas Benkarda1e84432023-12-05 21:12:16 +01001// SPDX-FileCopyrightText: © 2023 Matthias Andreas Benkard <code@mail.matthias.benkard.de>
2//
3// SPDX-License-Identifier: GPL-3.0-or-later
4
Matthias Andreas Benkard716fc322023-12-12 19:13:01 +01005/**
6 * The {@code jgvariant} command line tool.
7 *
8 * <p>The {@link eu.mulk.jgvariant.tool} module contains a tool called
9 * {@code jgvariant} that can be used to manipulate GVariant-formatted
10 * files from the command line. Its primary purpose is to enable the
11 * scripting of OSTree repository management tasks.
12 *
13 * <p>The {@link eu.mulk.jgvariant.tool.Main} class defines the entry point
14 * of the tool.
15 *
16 * <p>Usage example (dumping the contents of an OSTree summary file):
17 *
18 * {@snippet lang="sh" :
19 * $ jgvariant ostree summary read ./jgvariant-ostree/src/test/resources/ostree/summary
20 * }
21 *
22 * <p>Output:
23 *
24 * {@snippet lang="json" :
25 * {
26 * "entries": [
27 * {
28 * "ref": "mulkos/1.x/amd64",
29 * "value": {
30 * "checksum": "66ff167ff35ce87daac817447a9490a262ee75f095f017716a6eb1a9d9eb3350",
31 * "metadata": {
32 * "fields": {
33 * "ostree.commit.timestamp": 1640537170
34 * }
35 * },
36 * "size": 214
37 * }
38 * }
39 * ],
40 * "metadata": {
41 * "fields": {
42 * "ostree.summary.last-modified": 1640537300,
43 * "ostree.summary.tombstone-commits": false,
44 * "ostree.static-deltas": {
45 * "3d3b3329dca38871f29aeda1bf5854d76c707fa269759a899d0985c91815fe6f-66ff167ff35ce87daac817447a9490a262ee75f095f017716a6eb1a9d9eb3350": "03738040e28e7662e9c9d2599c530ea974e642c9f87e6c00cbaa39a0cdac8d44",
46 * "31c8835d5c9d2c6687a50091c85142d1b2d853ff416a9fb81b4ee30754510d52": "f481144629474bd88c106e45ac405ebd75b324b0655af1aec14b31786ae1fd61",
47 * "31c8835d5c9d2c6687a50091c85142d1b2d853ff416a9fb81b4ee30754510d52-3d3b3329dca38871f29aeda1bf5854d76c707fa269759a899d0985c91815fe6f": "2c6a07bc1cf4d7ce7d00f82d7d2d6d156fd0e31d476851b46dc2306b181b064a"
48 * },
49 * "ostree.summary.mode": "bare",
50 * "ostree.summary.indexed-deltas": true
51 * }
52 * }
53 * }
54 * }
55 */
Matthias Andreas Benkardec2c34a2024-03-02 13:48:04 +010056module eu.mulk.jgvariant.tool {
Matthias Andreas Benkarda1e84432023-12-05 21:12:16 +010057 requires transitive eu.mulk.jgvariant.ostree;
Matthias Andreas Benkarda1e84432023-12-05 21:12:16 +010058 requires info.picocli;
59 requires jakarta.json;
60 requires jakarta.json.bind;
61 requires java.logging;
62 requires static com.google.errorprone.annotations;
63 requires static org.apiguardian.api;
64 requires static org.jetbrains.annotations;
65
66 opens eu.mulk.jgvariant.tool to
67 info.picocli;
68
69 exports eu.mulk.jgvariant.tool;
70}