aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKirill Ponomarev <krion@FreeBSD.org>2005-04-08 09:45:18 +0000
committerKirill Ponomarev <krion@FreeBSD.org>2005-04-08 09:45:18 +0000
commitac4a0d8a8be067a278045cd65eedfd98e18f4bb8 (patch)
treed4e902dc098bc425c19753cc49442571694ddc7c
parentadd1c1c687e825b051a0a43175553d1f84feb121 (diff)
downloaddoc-ac4a0d8a8be067a278045cd65eedfd98e18f4bb8.tar.gz
doc-ac4a0d8a8be067a278045cd65eedfd98e18f4bb8.zip
Add convention about patch names, which was discussed many times,
but no consensus was done. PLEASE NOTE: - This rule is valid for all *NEW* patches, which committers will add into the ports. - It does *NOT* affect old patches which are still in the tree. So please do *NOT* change existing patch names just for new convention. - Change patch names *ONLY* if you modify content of the patch. Discussed with: linimon Checked by: simon
Notes
Notes: svn path=/head/; revision=24256
-rw-r--r--en_US.ISO8859-1/books/porters-handbook/book.sgml18
1 files changed, 11 insertions, 7 deletions
diff --git a/en_US.ISO8859-1/books/porters-handbook/book.sgml b/en_US.ISO8859-1/books/porters-handbook/book.sgml
index f0fb98065c..392c038572 100644
--- a/en_US.ISO8859-1/books/porters-handbook/book.sgml
+++ b/en_US.ISO8859-1/books/porters-handbook/book.sgml
@@ -642,21 +642,25 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
wish to apply should be collected into a file named
<filename>patch-<replaceable>*</replaceable></filename> where
<replaceable>*</replaceable> denotes the sequence in which the
- patches will be applied &mdash; these are done in
- <emphasis>alphabetical order</emphasis>, thus <literal>aa</literal>
- first, <literal>ab</literal> second and so on. If you wish,
- you can use names that indicate the pathnames of the files that
- are patched, such as <filename>patch-Imakefile</filename> or
+ patches will be applied. Please use names that indicate
+ the pathnames of the files that are patched,
+ such as <filename>patch-Imakefile</filename> or
<filename>patch-src-config.h</filename>. These files should
be stored in <makevar>PATCHDIR</makevar>, from where they will be
automatically applied. All patches should be relative to
<makevar>WRKSRC</makevar> (generally the directory your port's
tarball unpacks itself into, that being where the build is done).
To make fixes and upgrades easier, you should avoid having more than
- one patch fix the same file (e.g., <filename>patch-aa</filename> and
- <filename>patch-ab</filename> both changing
+ one patch fix the same file (e.g., <filename>patch-file</filename> and
+ <filename>patch-file</filename> both changing
<filename><makevar>WRKSRC</makevar>/foobar.c</filename>).</para>
+ <para>Please use only <literal>[-_a-zA-Z0-9]</literal> characters for
+ naming your patches. Do not use any other characters besides them.
+ Do not name your patches like <filename>patch-aa</filename> or
+ <filename>patch-ab</filename> etc, always mention path and file name
+ in patch names.</para>
+
<para>Do not put RCS strings in patches. CVS will mangle them when we
put the files into the ports tree, and when we check them out again,
they will come out different and the patch will fail. RCS strings