Skip to content

Commit b101cd4

Browse files
committed
docs: update README
1 parent 9923c9d commit b101cd4

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

rust/patchable/README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,11 @@ Patchable uses a two-level configuration system:
3838

3939
The product-level config contains:
4040
- `upstream` - the URL of the upstream repository (such as `https://github.com/apache/druid.git`)
41-
- `mirror` - optional URL of a mirror repository (such as `https://github.com/stackabletech/druid.git`)
41+
- `default_mirror` - optional: default URL of a mirror repository (such as `https://github.com/stackabletech/druid.git`)
4242

4343
The version-level config contains:
4444
- `base` - the commit hash of the upstream base commit
45+
- `mirror` - optional: URL of the mirror repository for this version, if mirroring is enabled
4546

4647
### Template
4748

@@ -52,11 +53,14 @@ upstream = "https://github.com/apache/druid.git"
5253
mirror = "https://github.com/stackabletech/druid.git"
5354
```
5455

55-
If you just want to add a new version, initiatilize the version-level config with patchable:
56-
```
57-
cargo patchable init druid 28.0.0 --base=druid-28.0.0
56+
If you just want to add a new version, initialize the version-level config with patchable:
57+
```sh
58+
cargo patchable init druid 28.0.0 --base=druid-28.0.0 --mirror
5859
```
5960

61+
This will initialize the version-level config with the base commit hash and the default mirror URL from the product-level config.
62+
You can optionally provide the `--ssh` flag to use SSH instead of HTTPS for Git operations.
63+
6064
## Glossary
6165

6266
- Images repo/directory - The checkout of stackabletech/docker-images

0 commit comments

Comments
 (0)