xdiff_file_patch(3) [php man page]

XDIFF_FILE_PATCH(3)							 1						       XDIFF_FILE_PATCH(3)

xdiff_file_patch - Patch a file with an unified diff

SYNOPSIS

       mixed xdiff_file_patch (string  $file, string  $patch, string  $dest, [int  $flags = DIFF_PATCH_NORMAL])

DESCRIPTION

	Patches   a   $file   with   a	 $patch   and	stores	 the   result	in   a	file.  $patch  has  to	be  an	unified  diff  created	by
       xdiff_file_diff(3)/xdiff_string_diff(3) function. An optional $flags parameter specifies mode of operation.

PARAMETERS

	      o $file
		- The original file.

	      o $patch
		- The unified patch file. It has to be created using xdiff_string_diff(3), xdiff_file_diff(3) functions or compatible tools.

	      o $dest
		- Path of the resulting file.

	      o $flags
		- Can be either XDIFF_PATCH_NORMAL (default mode, normal patch) or XDIFF_PATCH_REVERSE (reversed patch).   Starting  from  version
		1.5.0, you can also use binary OR to enable XDIFF_PATCH_IGNORESPACE flag.

RETURN VALUES

	Returns  FALSE	if an internal error happened, string with rejected chunks if patch couldn't be applied or TRUE if patch has been success-
       fully applied.

EXAMPLES

       Example #1

	      xdiff_file_patch(3) example

	       The following code applies unified diff to a file.

	      <?php
	      $old_version = 'my_script-1.0.php';
	      $patch = 'my_script.patch';

	      $errors = xdiff_file_patch($old_version, $patch, 'my_script-1.1.php');
	      if (is_string($errors)) {
		 echo "Rejects:
";
		 echo $errors;
	      }

	      ?>

       Example #2

	      Patch reversing example

	       The following code reverses a patch.

	      <?php
	      $new_version = 'my_script-1.1.php';
	      $patch = 'my_script.patch';

	      $errors = xdiff_file_patch($new_version, $patch, 'my_script-1.0.php', XDIFF_PATCH_REVERSE);
	      if (is_string($errors)) {
		 echo "Rejects:
";
		 echo $errors;
	      }

	      ?>

SEE ALSO

       xdiff_file_diff(3).

PHP Documentation Group 												       XDIFF_FILE_PATCH(3)

STG-EDIT(1)							   StGit Manual 						       STG-EDIT(1)

NAME

       stg-edit - edit a patch description or diff

SYNOPSIS

       stg edit [options] [<patch>]

DESCRIPTION

       Edit the description and author information of the given patch (or the current patch if no patch name was given). With --diff, also edit
       the diff.

       The editor is invoked with the following contents:

	   From: A U Thor <author@example.com>
	   Date: creation date

	   Patch description

       If --diff was specified, the diff appears at the bottom, after a separator:

	   ---

	   Diff text

       Command-line options can be used to modify specific information without invoking the editor. (With the --edit option, the editor is invoked
       even if such command-line options are given.)

       If the patch diff is edited but does not apply, no changes are made to the patch at all. The edited patch is saved to a file which you can
       feed to "stg edit --file", once you have made sure it does apply.

OPTIONS

       -d, --diff
	   Edit the patch diff.

       -e, --edit
	   Invoke interactive editor.

       --sign
	   Add a "Signed-off-by:" to the end of the patch.

       --ack
	   Add an "Acked-by:" line to the end of the patch.

       -m MESSAGE, --message MESSAGE
	   Use MESSAGE instead of invoking the editor.

       -f FILE, --file FILE
	   Use the contents of FILE instead of invoking the editor. (If FILE is "-", write to stdout.)

       --save-template FILE
	   Instead of running the command, just write the message template to FILE, and exit. (If FILE is "-", write to stdout.)

	   When driving StGit from another program, it is often useful to first call a command with --save-template, then let the user edit the
	   message, and then call the same command with --file.

       --author "NAME <EMAIL>"
	   Set the author details.

       --authname NAME
	   Set the author name.

       --authemail EMAIL
	   Set the author email.

       --authdate DATE
	   Set the author date.

       -O OPTIONS, --diff-opts OPTIONS
	   Extra options to pass to "git diff".

STGIT

       Part of the StGit suite - see linkman:stg[1]

StGit								    03/13/2012							       STG-EDIT(1)