# # # patch "ChangeLog" # from [ac47679a358a459a5f5e2c38a5ba2a2c049426a8] # to [2019a45fdab37692082583b9400712ed5c9318f0] # # patch "monotone.texi" # from [b032e26d6e1fdec14a573061fb411780def43795] # to [796fad813ada035e4368422394e781eb97d212ca] # ============================================================ --- ChangeLog ac47679a358a459a5f5e2c38a5ba2a2c049426a8 +++ ChangeLog 2019a45fdab37692082583b9400712ed5c9318f0 @@ -1,3 +1,8 @@ +2006-03-05 Nathaniel Smith + + * monotone.texi (Hooks): Update merge2 and merge3 hook + documentation to reflect current reality. + 2006-03-05 Graydon Hoare * lru_cache.h: New file. ============================================================ --- monotone.texi b032e26d6e1fdec14a573061fb411780def43795 +++ monotone.texi 796fad813ada035e4368422394e781eb97d212ca @@ -6508,16 +6508,24 @@ @ftable @code @anchor{merge2} address@hidden merge2 (@var{left}, @var{right}) address@hidden merge2 (@var{left_path}, @var{right_path}, @var{merged_path}, @var{left_text}, @var{right_path}) -Returns a string, which should be the merger of the 2 provided -strings, which are the contents of the @var{left} and @var{right} -nodes of a file fork which monotone was unable to automatically -merge. This hook delegates the actual merge -to the result of @ref{get_preferred_merge2_command}. -For the default definition of this hook, see @ref{Default hooks}. +This hook is called to resolve merges that monotone could not resolve +automatically. The left and right contents of the file are passed in +the @var{left_text}, and @var{right_text} strings. In addition, the +hook is given the names that this file had in left (@var{left_path} +and right (@var{right_path}) trees, and the name it will end up having +in the merged tree (@var{merged_path}). These paths are useful for +merge tools that can display the names of files in their GUI, since +the actual path names are likely more meaningful than the temporary +file names the merge tool will actually be working on. +Returns a string, which should be the merger of the given texts. The +default definition of this hook delegates the actual merge to the +result of @ref{get_preferred_merge2_command}. For the default +definition of this hook, see @ref{Default hooks}. + @anchor{get_preferred_merge2_command} @item get_preferred_merge2_command(@var{tbl}) @@ -6529,16 +6537,26 @@ @anchor{merge3} address@hidden merge3 (@var{ancestor}, @var{left}, @var{right}) address@hidden merge3 (@var{ancestor_path}, @var{left_path}, @var{right_path}, @var{merged_path}, @var{ancestor_text}, @var{left_text}, @var{right_text}) -Returns a string, which should be the merger of the 3 provided -strings, which are the contents of @var{left} and @var{right} nodes, -and least common @var{ancestor}, of a file fork which monotone was -unable to automatically merge. This hook delegates the actual merge -to the result of @ref{get_preferred_merge3_command}. -For the default definition of this hook, see @ref{Default hooks}. +This hook is called to resolve merges that monotone could not resolve +automatically. The actual ancestor, left, and right contents of the +file are passed in the @var{ancestor_text}, @var{left_text}, and address@hidden strings. In addition, the hook is given the names +that this file had in the ancestor (@var{ancestor_path}), left +(@var{left_path}), and right (@var{right_path}) trees, and the name it +will end up having in the merged tree (@var{merged_path}). These +paths are useful for merge tools that can display the names of files +in their GUI, since the actual path names are likely more meaningful +than the temporary file names the merge tool will actually be working +on. +Returns a string, which should be the merger of the given texts. The +default definition of this hook delegates the actual merge to the +result of @ref{get_preferred_merge3_command}. For the default +definition of this hook, see @ref{Default hooks}. + @anchor{get_preferred_merge3_command} @item get_preferred_merge3_command(@var{tbl})