Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Unified Diff: patchconv/README.md

Issue 29341347: Noissue - Add a script for converting Rietveld patches to Git format (Closed)
Patch Set: Created May 12, 2016, 5:50 p.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | patchconv/patchconv.py » ('j') | patchconv/patchconv.py » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: patchconv/README.md
===================================================================
new file mode 100644
--- /dev/null
+++ b/patchconv/README.md
@@ -0,0 +1,31 @@
+# Convert Rietveld patches to apply them locally
+
+The `patchconv` module and `patchconv` script convert SVN-style patches that
+are downloaded from [Rietveld](https://github.com/rietveld-codereview/rietveld)
+code reviews to Git-style patches that can be used as input for `hg import` or
+`git apply`.
+
+In many cases the patches from the review can be applied directly with
+`patch -p1`. However, if the changes contain copies or renames or include
+binary files, `patch` will not apply them correctly. Git and Mercurial commands
+will also not work because when the changes are uploaded to the review, they
+are converted to SVN-like format that Rietveld normally works with. `patchconv`
+undoes this conversion and returns the patch to the state where it can be
+applied using Git or Mercurial.
+
+## Installation
+
+Install directly from Mercurial repository using pip:
+
+ $ pip install 'hg+https://hg.[Dadblockplus.org/codingtools#egg=patchconv&subdirectory=patchconv'
+
+## Usage
+
+The script in the package will be available immediately after the installation.
+Its interface is simple: it reads from stdin and writes to stdout.
+
+ $ patchconv <patch-from-rietveld.diff >git-patch.diff
+
+## Testing
+
+The tests can be run via [Tox](http://tox.readthedocs.org/)
« no previous file with comments | « no previous file | patchconv/patchconv.py » ('j') | patchconv/patchconv.py » ('J')

Powered by Google App Engine
This is Rietveld