Move the specs under docs/spec, ahead of the source import
This commit is contained in:
@@ -3,7 +3,7 @@
|
|||||||
## strip.py
|
## strip.py
|
||||||
|
|
||||||
Makes an Enterprise-free snapshot of an upstream release. See the docstring
|
Makes an Enterprise-free snapshot of an upstream release. See the docstring
|
||||||
and SPEC.md §2.2 for what it does and why.
|
and docs/spec/SPEC.md §2.2 for what it does and why.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/stalwartlabs/stalwart.git ~/src/stalwart-upstream # outside this repo
|
git clone https://github.com/stalwartlabs/stalwart.git ~/src/stalwart-upstream # outside this repo
|
||||||
|
|||||||
+2
-2
@@ -6,7 +6,7 @@ Produce an Enterprise-free snapshot of an upstream Stalwart release.
|
|||||||
|
|
||||||
tools/fork/strip.py --upstream PATH/TO/stalwart --ref v0.16.22 --out DIR
|
tools/fork/strip.py --upstream PATH/TO/stalwart --ref v0.16.22 --out DIR
|
||||||
|
|
||||||
What it does, in order (SPEC.md §2.2):
|
What it does, in order (docs/spec/SPEC.md §2.2):
|
||||||
|
|
||||||
1. Exports the tree at `--ref` with `git archive`. The snapshot never carries
|
1. Exports the tree at `--ref` with `git archive`. The snapshot never carries
|
||||||
upstream's git history, because that history contains the Enterprise code.
|
upstream's git history, because that history contains the Enterprise code.
|
||||||
@@ -31,7 +31,7 @@ What it does, in order (SPEC.md §2.2):
|
|||||||
|
|
||||||
Only license markers and Cargo manifests are read for meaning. The code inside
|
Only license markers and Cargo manifests are read for meaning. The code inside
|
||||||
an Enterprise file or snippet is never printed, reported or kept, which is what
|
an Enterprise file or snippet is never printed, reported or kept, which is what
|
||||||
lets anyone run this outside the clean room (SPEC.md §3).
|
lets anyone run this outside the clean room (docs/spec/SPEC.md §3).
|
||||||
|
|
||||||
Exit status: 0 clean, 1 verification failed, 2 usage or environment error.
|
Exit status: 0 clean, 1 verification failed, 2 usage or environment error.
|
||||||
"""
|
"""
|
||||||
|
|||||||
Reference in New Issue
Block a user