[Quilt-dev] README quick-references (v2)

[Randy.Dunlap]

On Tue, 8 Nov 2005 10:51:20 +0100 Andreas Gruenbacher wrote:

> Hello,
> 
> On Tuesday 08 November 2005 05:03, Randy.Dunlap wrote:
> > Any interest in this?
> 
> Yes, we can add this.

> > +Other patch management:
> > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > +1.  list files in a patch: quilt files {patchname}
> 
> Duplicate entry?

Removed it.

> > +14. combine patches for distribution:      quilt diff --combine
> 
> > +   and distribute the patches/ directory content
> 
> That's unclear to me.

Agreed, fixed, I hope/think.

---
~Randy


Add a README quick-reference section for Typical Usages.
v2, with corrections as indicated by Andreas.

--- doc/README.in~quick_ref     2005-07-02 14:14:50.000000000 -0700
+++ doc/README.in       2005-12-25 19:54:13.000000000 -0800
@@ -33,3 +33,80 @@ backup-files
        A simple utility that creates / restores / removes
        backup files.
 
+
+Typical Usages:  New patches; Importing patches; Patch management
+======================================================================
+
+Add new patches:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1.  create a new patch:                quilt new {patchname, e.g., 
sysctl_fix.patch}
+
+2.  add/edit file(s):          quilt edit filepath
+or:
+2a. add file(s) to patch:      quilt add {filepath}
+2b. manual edit file(s)                use your $editor
+
+3.  update the patch diff:             quilt refresh
+3b. list the patch description:                quilt header [patch]
+3c. update the patch description:      quilt header -e [patch]
+
+4.  list files in the patch:   quilt files
+
+5.  show the patch:            quilt diff
+
+6.  apply current, ready for next:     quilt push
+
+7.  remove file(s) from patch: quilt remove {filepath}
+
+Importing patches:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1.  import a patch:            quilt import patchfile
+
+2.  apply it:                  quilt push
+
+3.  update the patch diff:             quilt refresh
+3b. list the patch description:                quilt header [patch]
+3c. update the patch description:      quilt header -e [patch]
+
+4.  list files in the patch:   quilt files
+
+5.  show the patch:            quilt diff
+
+Import/Apply a series file + patches to a tree:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1.  cp(1) the patches directory ('series' file + all patch files) to
+    the expected patches location (as specified in your .quiltrc file)
+
+2.  apply all of series:       quilt push -a
+
+Other patch management:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1.  remove files from a patch: quilt remove {filepath}
+
+2.  remove unapplied patch:    quilt delete {patchname}
+
+3.  list all patch names:      quilt series
+
+4.  list all applied/unapplied:        quilt applied | unapplied
+
+5.  list top/previous/next patch name: quilt top | previous | next
+
+6.  list patches modifying file:       quilt patches {filepath}
+
+7.  rename a patch:            quilt rename {patchname}
+
+8.  duplicate a patch:         quilt fork {patchname}
+
+9.  prepare or send mails:     quilt mail ...
+
+10. search in source files:    quilt grep ...
+
+11. create snapshot:           quilt snapshot
+
+12. init from RPM spec or series file: quilt setup
+
+13. distribution of patches:   quilt diff --combine
+               and distribute the combined diff file,
+       or distribute the patches/ directory content
+
+###