diff options
Diffstat (limited to 'doc/user')
| -rw-r--r-- | doc/user/index.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/user/index.rst b/doc/user/index.rst index 2d311c6..fdca7bd 100644 --- a/doc/user/index.rst +++ b/doc/user/index.rst @@ -1,6 +1,9 @@ +========= User docs ========= +This page contains information useful to people who want to use the .patch files generated by patchtree. + .. note:: By convention, the patch file should be placed in the root of the target directory under the filename ``.patchtree.diff``. @@ -12,6 +15,7 @@ User docs Patches produced by patchtree contain *extended header lines* which are be interpreted by ``git apply``. Because these header lines must include the path to each modified file relative to the repository root, any files which don't exist at the expected location will be skipped silently by ``git``. +**************** Applying a patch **************** @@ -21,6 +25,7 @@ To apply the patch, run the following command in the target directory:: $ git apply .patchtree.diff +***************** Reverting a patch ***************** @@ -28,6 +33,7 @@ To revert the changes of a patch, run the following command in the target direct $ git apply --reverse .patchtree.diff +***************** Upgrading a patch ***************** |