Skip to content

Commit 2adc5e1

Browse files
committed
fix: adjust README
1 parent 43f33c1 commit 2adc5e1

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

rust/patchable/README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,13 @@ Patchable uses a two-level configuration system:
3636
1. A product-level config file at `docker-images/<PRODUCT>/stackable/patches/patchable.toml`
3737
2. A version-level config file at `docker-images/<PRODUCT>/stackable/patches/<VERSION>/patchable.toml`
3838

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

43-
The version-level config typically contains:
43+
The version-level config contains:
4444
- `base` - the commit hash of the upstream base commit
4545

46-
Fields in the version-level config override those in the product-level config if both are specified.
47-
4846
### Template
4947

5048
If you're adding a completely new product, you need to create the product-level config once:
@@ -54,13 +52,11 @@ upstream = "https://github.com/apache/druid.git"
5452
mirror = "https://github.com/stackabletech/druid.git"
5553
```
5654

57-
If you just want to add a new version, simply initiatilize it with patchable:
55+
If you just want to add a new version, initiatilize the version-level config with patchable:
5856
```
5957
cargo patchable init druid 28.0.0 --base=druid-28.0.0 --mirror
6058
```
6159

62-
Using the `--mirror` flag will push the base ref to the mirror URL specified in the product-level config.
63-
6460
## Glossary
6561

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

0 commit comments

Comments
 (0)