Changeset 406

Timestamp:

Oct 6, 2012, 1:27:09 AM (10 years ago)

Author:

ehem

Message:

Everyone's favorite, documentation. Hopefully this is an improvement over
the last version. Also adding a mention of the ability to include a branch
name in the filename, unlikely to be used by DebWRT patches, but quite possibly
useful for plugin patches to OpenWRT.

File:

• branches/contrib/openwrt/patches/README (modified) (2 diffs)

branches/contrib/openwrt/patches/README

@@ -7 +7 @@
 backfire/ Patches that apply only to OpenWrt backfire branch
 
-Patches in these directories have the following format:
+Patches in these directories must have filenames of the form:
 
-nnn_<desc>          Apply patch to all revisions
-nnn-[b]:[e]_<desc>  Apply patch to revisions b through e, inclusive. If
-                    b is omitted, it will be applied to all revisions
-                    before e. If e is ommitted, it will be applied to all
-                    revisions after b. If b equals e, it will be applied
-                    to only a single revision. If b is greater than e, it
-                    will never be used.
+<nnn>_<desc>
+        Apply patch to all revisions
+<nnn>[-<branch>][-[<first>]:[<last>]]_<desc>
+        The portions in brackets [] are optional.  If present, <branch> will
+        cause the patch to only be applied to the indicated branch of OpenWrt,
+        "all" will make it applIy to all branches.  <first> and <last> are used
+        to indicate an inclusive range of OpenWrt revisions which the patch
+        applies to.  If <last> is omitted, it will be applied to all revisions
+        after <first>.  If <first> is omitted, it will be applied to all
+        revisions before <last>.  If <first> equals <last>, it will be applied
+        to that single revision.  If <first> is greater than <last>, it will
+        never be used.
 
-<desc> contains a functional description of the patch. Prefereably seperated
-       by _.
 
-Patches are applied in order of nnn.
+<nnn>  is used to set order of application. Lower numbered patches are applied
+       first. The ordering is done by running the list of patches through
+       `sort`, as a result,  "1000_foo" will be done before "200_bar".
+
+<desc> contains a functional description of the patch. Usually separated by
+       underscores.
+
+Minor technical note: The script is actually trying to parse everything up to
+the first underscore. Everything after that is ignored.
+
+
+Patches are applied inside the checked out OpenWRT using `patch -p0`. Patches
+directly from other sources may need to be adjusted to match this (the command
+`sed -e's/^\(\(+++\)\|\(---\)\) [^\/]*\//\1 /' -i` will do this).
+
 
 Make targets
@@ -35 +52 @@
 diff -Nu packages/broadcom-wl/patchesnew/999_remove_IRWF_SAMPLE_RANDOM \
          packages/broadcom-wl/patches/999_remove_IRWF_SAMPLE_RANDOM \
-         > ../../030-33559:broadcom-wl_remove_IRWF_SAMPLE_RANDOM.patch
+         > ../../030-33559:_broadcom-wl_remove_IRWF_SAMPLE_RANDOM.patch