From 3547e32746085c662bd721e9aa1fab9d13d8b304 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Sun, 4 May 2014 23:48:07 +0200 Subject: improve the documentation about the layout of a working directory --- doc/quilt.1.in | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) (limited to 'doc/quilt.1.in') diff --git a/doc/quilt.1.in b/doc/quilt.1.in index 709d702..ee64ec4 100644 --- a/doc/quilt.1.in +++ b/doc/quilt.1.in @@ -138,19 +138,34 @@ around quilt. .fam C .RS .nf -work/ -+- ... - |- patches/ -+- series - | |- patch2.diff - | |- patch1.diff - | +- ... - +- .pc/ -+- applied-patches - |- patch1.diff/ -+- ... - |- patch2.diff/ -+- ... - +- ... +work/ +├── patches/ +│ ├── series (list of patches to apply) +│ ├── patch1.diff (one particular patch) +│ ├── patch2.diff +│ └── ... +├── .pc/ +│ ├── .quilt_patches (content of QUILT_PATCHES) +│ ├── .quilt_series (content of QUILT_SERIES) +│ ├── patch1.diff/ (copy of patched files) +│ │ └── ... +│ ├── patch2.diff/ +│ │ └── ... +│ └── ... +└── ... .fi .RE .fam T +The patches/ directory is precious as it contains all your patches as +well as the order in which it should be applied. + +The .pc/ directory contains some metadata about the current state of +your patch serie. Changing its content is not advised. This directory +can usually be regenerated from the initial files and the +content of the patches/ directory (provided that all patches were +regenerated before the removal). + .SH EXAMPLE Please refer to the pdf documentation for a full example of use. -- cgit