Changeset 129849 for trunk/doc-new


Ignore:
Timestamp:
Dec 21, 2014, 3:40:37 PM (4 years ago)
Author:
raimue@…
Message:

guide: clarify section on patch file names

Using the target path is not a strict requirement for patch file names in
current practice.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc-new/guide/xml/portfiledev.xml

    r129847 r129849  
    577577      application.</para>
    578578
    579       <para>Generally speaking, you should create one patch file for each file
    580       to be patched. Patchfile filenames should uniquely distinguish the file
    581       and generally be of the form
    582       <filename>patch-</filename><replaceable>&lt;directory&gt;</replaceable>-<replaceable>&lt;filename&gt;.diff</replaceable>,
    583       as shown in this example:
    584       <filename>patch-src-Makefile.in.diff</filename>.</para>
     579      <para>Generally speaking, you should create one patch file for each
     580      logical change that needs to be applied. Patchfile filenames should
     581      uniquely distinguish the file and generally be of the form
     582      <filename>patch-</filename><replaceable>&lt;identifier&gt;</replaceable><filename>.diff</filename>,
     583      where the <replaceable>identifier</replaceable> is a hint of what the
     584      patch does. For example, this can be the filename of the patched file as in
     585      <filename>patch-</filename><replaceable>src-Makefile.in</replaceable><filename>.diff</filename>.</para>
    585586
    586587      <para>You may use patch files that patch multiple files under these
     
    594595        <listitem>
    595596          <para>If fixing a particular problem or bug requires changes in
    596           multiple files -in those cases the patch filename should reference
     597          multiple files&mdash;in those cases the patch filename should reference
    597598          the problem or bug, for example:
    598           <filename>patch-</filename><replaceable>&lt;destroot_variable_fix&gt;.diff</replaceable></para>
     599          <filename>patch-</filename><replaceable>destdir-variable-fix</replaceable><filename>.diff</filename></para>
    599600        </listitem>
    600601      </itemizedlist>
Note: See TracChangeset for help on using the changeset viewer.