ChangeSet ID: 11565997970401934530391408
CVSROOT: /cvsroot/wine
Module name: docs
Changes by: dimi(a)sc8-pr-cvs9.sourceforge.net 2006/08/26 06:43:17
Modified files:
en : winedev-coding.sgml
Log message:
Mike McCormack <mike(a)codeweavers.com>
Describe using Git to send patches.
Old revision New revision Changes Path
1.5 1.6 +19 -36 docs/en/winedev-coding.sgml
Index: docs/en/winedev-coding.sgml
diff -u -p docs/en/winedev-coding.sgml:1.5 docs/en/winedev-coding.sgml:1.6
--- docs/en/winedev-coding.sgml 26 Aug 2006 13:43:17 -0000
+++ /dev/null 26 Aug 2006 13:43:17 -0000
@@ -35,7 +35,7 @@
</listitem>
<listitem>
<para>
- The patch in <command>diff -u</command> format
+ The patch in <quote>Git</quote> format
</para>
</listitem>
</itemizedlist>
@@ -43,40 +43,23 @@
<para></para>
<para>
- <command>cvs diff -u</command> works great for the common case
- where a file is edited. However, if you add or remove a file
- <command>cvs diff</command> will not report that correctly so
- make sure you explicitly take care of this rare case.
+ To generate a patch using Git, first commit it to your local tree.
</para>
<para>
- For additions simply include them by appending the
- <command>diff -u /dev/null /my/new/file</command> output of
- them to any <command>cvs diff -u</command> output you may
- have. Alternatively, use <command>diff -Nu olddir/
- newdir/</command> in case of multiple new files to add.
+ Each file that you change needs to be updated with
+ <command> git update </command>. If you are adding or removing
+ a file, use <command> git update --add </command> or
+ <command>git update --remove</command> respectively.
+ After updating the index, commit the change using
+ <command> git commit </command>. The commit message will be
+ sent with your patch, and recored in the ChangeLog.
+ </para>
+ <para>
+ After committing the patch, you can extract it using
+ <command>git format-patch</command> and send it to wine-patches
+ using <command>git imap-send</command> or simply attaching it
+ to you mail manually.
</para>
- <para>
- When adding a new directory that contains a
- <filename>Makefile.in</filename>, you must ensure that
- <filename>configure.ac</filename> references it.
- Naturally, your patch should include all the changes you
- made to integrate the new directory into the tree.
- </para>
- <para>
- For removals, clearly list the files in the description of the
- patch.
- </para>
- <para>
- Since wine is constantly changing due to development it is
- strongly recommended that you use cvs for patches, if you
- cannot use cvs for some reason, you can submit patches against
- the latest tarball. To do this make a copy of the files that
- you will be modifying and <command>diff -u</command> against
- the old file. I.E.
- </para>
- <screen>
-diff -u file.old file.c > file.txt
- </screen>
</sect1>
<sect1 id="Style-notes">
@@ -222,11 +205,11 @@ code
can build on it and it will not go stale?")
</para>
<para>
- Make sure your patch applies to the current CVS head
- revisions. If a bunch of patches are committed to CVS that may
+ Make sure your patch applies to the current Git HEAD
+ revisions. If a bunch of patches are committed that may
affect whether your patch will apply cleanly then verify that
- your patch does apply! <command>cvs update</command> is your
- friend!
+ your patch does apply! <command>git fetch; git rebase origin</command>
+ is your friend!
</para>
<para>
Save yourself some embarrassment and run your patched code