summaryrefslogtreecommitdiffstats
path: root/doc/README.in
diff options
context:
space:
mode:
authorAndreas Gruenbacher <agruen@suse.de>2003-11-12 00:38:05 +0000
committerAndreas Gruenbacher <agruen@suse.de>2003-11-12 00:38:05 +0000
commitec4863a5bc56100f2e4ce746d0efb34729376bb8 (patch)
treecf7a5fbf1c39111e5a5ddfef2ffefe1889b0d6a7 /doc/README.in
parentaa2e20e1d6d2eef546613da566276b93c856de15 (diff)
downloadquilt-ec4863a5bc56100f2e4ce746d0efb34729376bb8.tar.gz
- Add introductory paper to CVS repository.
- Remove obsolete documentation.
Diffstat (limited to 'doc/README.in')
-rw-r--r--doc/README.in78
1 files changed, 2 insertions, 76 deletions
diff --git a/doc/README.in b/doc/README.in
index 83f252c..0f080d2 100644
--- a/doc/README.in
+++ b/doc/README.in
@@ -1,82 +1,8 @@
The scripts in this package simplify working with a series of patches.
The usual tasks like applying, refreshing and reversing are supported.
-docco.txt contains Adrew Morton's description of his suite of patch
-scripts. These scripts are based on Andrew's scripts, but include many
-changes. Please keep this in mind when reading Andrew's documentation.
-
-
-Concepts
-========
-
-(Please see docco.txt.)
-
-The scripts maintain a stack of patches, on top of which additional
-patches can be applied, and from with patches can be removed. The list of
-patches is kept in a file (searched for in this order in
-.pc/series, series, patches/series).
-
-The scripts keep meta information in the .pc/ directory. The .pc/
-directory contains:
-
- .pc/applied-patches
- The list of currently applied patches.
-
- .pc/patch/.pc (for each applied patch)
- A list of files modified by the patch.
-
- .pc/patch/ (for each applied patch)
- Copies of the files that the patch modifies,
- before modifying. The original versions of
- the files are needed for refreshing patches,
- and for ensuring that removing a patch does
- recreate the original file contents.
-
-
-Operation
-=========
-
-Patches to be applied must be listed in the series file.
-
-Patches are applied with pushpatch, and are removed with poppatch.
-
-Refpatch refreshes a patch.
-
-New patches can be added at the current position in the patch sequence
-with newpatch.
-
-Additional files to be modified can be added to a patch with patchadd.
-
-
-Installation
-============
-
-To start using the scripts the working directory must contain:
-
- patches/
- Patches to work with.
-
- series (or patches/series)
- List of patches in order of applying.
-
-The scripts will create the .pc/ directory that contains the meta
-information needed for managing the patches automatically.
-
-
-Series file
-===========
-
-The patches that are relevant for a project must be listed in the file
-series, which is searched for in .pc/, ./ and patches/ in this order.
-The patches will be applied in the order given. The series file has
-the following format:
-
- # Comment
- subdir/patch-file-name.patch [-pN]
-
-The location of patches is specified relative to the patches/ directory.
-Optionally a strip level (-p0, -p1, etc.) can be specified. When
-refreshing a patch, only levels 0 and 1 are supported.
+Please see the paper "How To Survive With Many Patches /or/
+Introduction to Quilt" for an introduction.
Command reference