From 65476b44a5a77797b75503a19636a510d5b2d104 Mon Sep 17 00:00:00 2001 From: Pritish Jain Date: Sat, 1 Dec 2018 14:57:48 +0530 Subject: coding-gen-patch:Convert TBD to rest Format(GCI 2018) --- eng/coding-gen-patch.rst | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) (limited to 'eng/coding-gen-patch.rst') diff --git a/eng/coding-gen-patch.rst b/eng/coding-gen-patch.rst index d4e05da..5f007d5 100644 --- a/eng/coding-gen-patch.rst +++ b/eng/coding-gen-patch.rst @@ -6,5 +6,30 @@ Generating a Tools Patch ************************ -TBD - Convert the following to Rest and insert into this file -TBD - https://devel.rtems.org/wiki/Developer/Coding/GenerateAPatch +.. COMMENT:TBD - Convert the following to Rest and insert into this file +.. COMMENT:TBD - https://devel.rtems.org/wiki/Developer/Coding/GenerateAPatch + +The RTEMS patches to the development tools are generated using a command like this + +.. code block:: shell + diff -N -P -r -c TOOL-original-image TOOL-with-changes >PATCHFILE + +where the options are: + +* -N and -P take care of adding and removing files (be careful not to +include junk files like file.mybackup) + +* -r tells diff to recurse through subdirectories +* -c is a context diff (easy to read for humans) +* -u is a unified diff (easy for patch to apply) + +Please look at the generated PATCHFILE and make sure it does not contain +anything you did not intend to send to the maintainers. It is easy to +accidentally leave a backup file in the modified source tree or have a +spurious change that should not be in the PATCHFILE. + +If you end up with the entire contents of a file in the patch and can't +figure out why, you may have different CR/LF scheme in the two source +files. The GNU open-source packages usually have UNIX style CR/LF. If +you edit on a Windows platform, the line terminators may have been +transformed by the editor into Windows style. -- cgit v1.2.3