Skip to content

Commit 75d05c6

Browse files
committed
HACKING: Remove oci-image-tool
The http/FileSystem stuff still applies, since the JSON Schema validation is staying in this repo. I've made it's earlier oci-image-tool references more generic, and adopted the README's recommended one sentence per line where I touched a line. Signed-off-by: W. Trevor King <[email protected]>
1 parent 5e24fb2 commit 75d05c6

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

HACKING.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,13 @@ $ make test
3333
$ make validate-examples
3434
```
3535

36-
### OCI image tool
37-
38-
This target builds the `oci-image-tool` binary.
39-
40-
Invocation:
41-
```
42-
$ make oci-image-tool
43-
```
44-
4536
### Virtual schema http/FileSystem
4637

47-
The `oci-image-tool` uses a virtual [http/FileSystem](https://golang.org/pkg/net/http/#FileSystem) to load the JSON schema files for validating OCI images and/or manifests. The virtual file system is generated using the `esc` tool and compiled into the `oci-image-tool` binary so the JSON schema files don't have to be distributed along with the binary.
38+
The `schema` validator uses a virtual [http/FileSystem](https://golang.org/pkg/net/http/#FileSystem) to load the JSON schema files for validating OCI images and/or manifests.
39+
The virtual file system is generated using the `esc` tool and compiled into consumers of the `schema` package so the JSON schema files don't have to be distributed along with and consumer binaries.
4840

49-
Whenever changes are being done in any of the `schema/*.json` files, one must refresh the generated virtual file system. Otherwise schema changes will not be visible inside the `oci-image-tool`.
41+
Whenever changes are being done in any of the `schema/*.json` files, one must refresh the generated virtual file system.
42+
Otherwise schema changes will not be visible inside `schema` consumers.
5043

5144
Prerequisites:
5245
* [esc](https://github.com/mjibson/esc)

0 commit comments

Comments
 (0)