# HG changeset patch # User Steve Losh # Date 1278998966 14400 # Node ID 9b78bb09a3dbb1cfeda3416445216cd7263c8086 # Parent d0f41ff4e65e131087a36f8d0ce94894cec73cd1 docs: cleanup diff -r d0f41ff4e65e -r 9b78bb09a3db docs/hacking.rst --- a/docs/hacking.rst Tue Jul 13 01:07:28 2010 -0400 +++ b/docs/hacking.rst Tue Jul 13 01:29:26 2010 -0400 @@ -6,8 +6,6 @@ The easiest way is to make some changes, push them somewhere public and send a pull request on Bitbucket (or `email Steve `_). -Here's what you need to know. - Rough Guidelines ---------------- diff -r d0f41ff4e65e -r 9b78bb09a3db docs/licensing.rst --- a/docs/licensing.rst Tue Jul 13 01:07:28 2010 -0400 +++ b/docs/licensing.rst Tue Jul 13 01:29:26 2010 -0400 @@ -8,3 +8,21 @@ If you want to create a program that works with hg-review you should look at `Mercurial's License FAQ page `_ to learn about how this might affect you. + +The basic idea is: + +* If you review code with hg-review, you are not affected by the license. +* If you bundle hg-review with another application and don't change anything, + you are not affected by the license. +* If you create an application that interacts with hg-review solely through its + command line interface or web interface, you are not affected by the license. +* If you create an application that interactes with hg-review by calling its + internal Python API, you *are* affected by the license and will need to + license your application's code as GPL version 2 or later. + +Note that the last item (using hg-review's internal Python API) is probably the +one you *won't* want to do anyway, since the Python API is *not* stable. + +If you have any questions please `email Steve `_, +but remember that he's not a lawyer and might not have a fast answer for tricky +questions. diff -r d0f41ff4e65e -r 9b78bb09a3db docs/overview.rst --- a/docs/overview.rst Tue Jul 13 01:07:28 2010 -0400 +++ b/docs/overview.rst Tue Jul 13 01:29:26 2010 -0400 @@ -8,7 +8,7 @@ ------------ hg-review requires `Python `_ 2.5 or later and `Mercurial -`_ 1.6 or later +`_ 1.6 or later. You probably have both of these requirements already, but if you encounter problems you might want to check these first with ``python --version`` and