diff options
Diffstat (limited to 'docs/index.rst')
-rw-r--r-- | docs/index.rst | 80 |
1 files changed, 73 insertions, 7 deletions
diff --git a/docs/index.rst b/docs/index.rst index 2a9ce05..7a9ce09 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,15 +1,81 @@ -Welcome to Patchwork's documentation! -===================================== +Patchwork +========= .. toctree:: :maxdepth: 2 :caption: Contents: +Patchwork is a patch tracking system for community-based projects. It is +intended to make the patch management process easier for both the project's +contributors and maintainers, leaving time for the more important (and more +interesting) stuff. +Patches that have been sent to a mailing list are 'caught' by the system, and +appear on a web page. Any comments posted that reference the patch are appended +to the patch page too. The project's maintainer can then scan through the list +of patches, marking each with a certain state, such as Accepted, Rejected or +Under Review. Old patches can be sent to the archive or deleted. -Indices and tables -================== +Currently, Patchwork is being used for a number of open-source projects, mostly +subsystems of the Linux kernel. Although Patchwork has been developed with the +kernel workflow in mind, the aim is to be flexible enough to suit the majority +of community projects. -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +Download +-------- + +The latest version of Patchwork is available with git. To download: + +.. code-block:: shell + + $ git clone git://github.com/getpatchwork/patchwork + +Patchwork is distributed under the `GNU General Public License (v2)`__. + +__ http://www.gnu.org/licenses/gpl-2.0.html + +Design +------ + +Patchwork should supplement mailing lists, not replace them +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Patchwork isn't intended to replace a community mailing list; that's why you +can't comment on a patch in Patchwork. If this were the case, then there would +be two forums of discussion on patches, which fragments the patch review +process. Developers who don't use Patchwork would get left out of the +discussion. + +However, a future development item for Patchwork is to facilitate on-list +commenting, by providing a "send a reply to the list" feature for logged-in +users. + +Don't pollute the project's changelogs with Patchwork poop +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A project's changelogs are valuable - we don't want to add Patchwork-specific +metadata. + +Patchwork users shouldn't require a specific version control system +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Not everyone uses git for kernel development, and not everyone uses git for +Patchwork-tracked projects. + +It's still possible to hook other programs into Patchwork, using the pwclient +command-line client for Patchwork, or directly to the XML RPC interface. + +Getting Started +--------------- + +You should check out the `deployment/installation` and +`development/installation` guides for information on how to configure +Patchwork for production and development environments, respectively. + +Support +------- + +All questions and contributions should be sent to the +`Patchwork mailing list`__ + +__ https://ozlabs.org/mailman/listinfo/patchwork |