From 281a9216e46e0751b621ce2940ed7f7df149bb55 Mon Sep 17 00:00:00 2001 From: Jethro Beekman Date: Wed, 2 Nov 2016 22:13:26 -0700 Subject: [PATCH] Update README --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f53be9a..2b7959b 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,27 @@ $ echo FULL_COMMIT_ID ...|GIT_DIR=/your/rust/dir/.git ./build-src.sh Instead of echoing in the commit IDs, you might pipe in `rustc-commit-db list-valid`. -The build-src script will prompt you to create patches for new commits. +The build-src script will prompt you to create patches for new commits. You +will be dropped in a shell prompt with a temporary new, clean, git repository +just for this patch. Make any changes necessary to make it build. **Don't** +commit any changes! When exiting the shell and the script will use the working +tree diff as the patch. The temporary git repository will be deleted. Before +dropping into the shell, the script will show you nearby commits, you can try +to apply `$PATCH_DIR/that_commit.patch` and see if it works for you. + +## Editing patches + +To edit all patches, again make a checkout of the rust source. Then, run: + +``` +$ GIT_DIR=/your/rust/dir/.git ./edit-patches.sh +``` + +The script will prompt you to make changes. You will be dropped in a shell +prompt with a temporary new, clean, git repository just for this patch edit. +The original patch will be the HEAD commit in the repository. Make any changes +you want. **Don't** commit any changes! When exiting the shell and the script +will use the diff between the working tree and the root commit as the patch. +The temporary git repository will be deleted. When editing further commits, the +previous patch changes will already be applied to the working tree (if +succesful).