summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Quinson <martin.quinson@loria.fr>2014-05-04 23:48:07 +0200
committerMartin Quinson <martin.quinson@loria.fr>2014-05-04 23:48:07 +0200
commit3547e32746085c662bd721e9aa1fab9d13d8b304 (patch)
tree6609c374ca5729e02a698684b0eda9e14997307e
parent9ce5f012e270c6f7e0144ea28317cdd1ea4107b3 (diff)
downloadquilt-3547e32746085c662bd721e9aa1fab9d13d8b304.tar.gz
improve the documentation about the layout of a working directory
-rw-r--r--doc/quilt.1.in33
1 files changed, 24 insertions, 9 deletions
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.