Loading...
Helix SwarmHelix Swarm
Loading...

merging.html

  • //
  • guest/
  • sam_stafford/
  • calamari/
  • help/
  • merging.html #1
  • View
  • Commits
  • Open Download .zip Download (6 KB) 
  1. <HTML>
  2. 	<HEAD>
  3. 		<TITLE></TITLE>
  4. 		<META NAME="GENERATOR" Content="Microsoft Visual Studio .NET 7.1">
  5. 	</HEAD>
  6. 	<BODY>
  7. 		<H3>Merging with CALAMARI</H3>
  8. 		<UL>
  9. 			<LI>
  10. 				<a href="#how">How CALAMARI merges files</a>
  11. 			<LI>
  12. 				<a href="#cli">Calling CALAMARI from the command line</a>
  13. 			<LI>
  14. 				<a href="#toolbar">The CALAMARI merge toolbar</a>
  15. 			<LI>
  16. 				<a href="#menus">The CALAMARI menus</a>
  17. 			<LI>
  18. 				<a href="#window">The CALAMARI merge window</a></LI></UL>
  19. 		<P>&nbsp;</P>
  20. 		<H4><a name="how">How CALAMARI merges files</a></H4>
  21. 		<P>A "three-way merge" is based on the concept of two files having "diffs" from a 
  22. 			base (common ancestor) file, and the ability to combine those diffs into a new 
  23. 			single file.&nbsp; The below example illustrates a base file having two changes 
  24. 			made to it, and those two changes being merged together:</P>
  25. 		<P><img src="qrc:/doc/help/merge-how.png"></P>
  26. 		<P>See "<a href="qrc:/doc/help/diffing.html#how">How CALAMARI diffs files</a>" for 
  27. 			more on how the diffs are determined.</P>
  28. 		<P>&nbsp;</P>
  29. 		<H4><a name="cli"></a>Calling CALAMARI from the command line</A></H4>
  30. 		<P>To merge files in CALAMARI, call <STRONG>calamari </STRONG>with the names of the 
  31. 			"base," "theirs," and "yours" files as arguments.&nbsp; You can optionally 
  32. 			specify the "result" file that the merge will be saved as; if you do not 
  33. 			specify a result filename, you will be prompted for one when you save.</P>
  34. 		<P><STRONG>calamari base.png theirs.png yours.png [result.png]</STRONG></P>
  35. 		<P>&nbsp;</P>
  36. 		<H4><a name="toolbar">The CALAMARI merge toolbar</a></H4>
  37. 		<P><img src="qrc:/doc/help/merge-toolbar.png"></P>
  38. 		<P><STRONG>Theirs stencil:</STRONG> Applies a "stencil" over the merge editor, both 
  39. 			obscuring parts of the result that do not correspond to diffs in the "theirs" 
  40. 			file, and preventing those parts from being painted over.</P>
  41. 		<P><STRONG>Yours stencil:</STRONG> Like the <STRONG>Theirs stencil</STRONG>, but 
  42. 			corresponds to diffs in the "yours" file.</P>
  43. 		<P><STRONG>Conflict stencil:</STRONG> Like the other two stencils, but corresponds 
  44. 			to conflicting diffs (usually the intersection of the "yours" and "theirs" 
  45. 			diffs).</P>
  46. 		<P><STRONG>Color options:</STRONG> Allows you to set the color of the stencils, the 
  47. 			color that <STRONG>Automerge</STRONG> paints conflicts with, the color that the <STRONG>
  48. 				Eraser</STRONG> replaces the image with,&nbsp;and the threshold at which 
  49. 			color differences are considered to be "diffs".</P>
  50. 		<P><STRONG>Zoom: </STRONG>Allows you to set the zoom level of the merge editor.</P>
  51. 		<P><STRONG>Automerge: </STRONG>Automatically merges the entire file by accepting 
  52. 			all non-conflicting diffs from both "theirs" and "yours".&nbsp; Conflicts will 
  53. 			be painted with the "conflict color" set in <STRONG>Color Options</STRONG>, and 
  54. 			should be replaced with "theirs" or "yours" before saving.</P>
  55. 		<P><STRONG>Paint: </STRONG>Allows you to selectively paint in the merge editor with 
  56. 			colors taken from the "theirs" file, the "yours" file, or a blend of the 
  57. 			two.&nbsp; The <STRONG>slider</STRONG> determines which of the two images you 
  58. 			will use.</P>
  59. 		<P><STRONG>Spray:</STRONG> Like the <STRONG>Paint</STRONG> tool, but it is 
  60. 			automatically applied to the entire image as the slider is moved.&nbsp; The <STRONG>
  61. 				Spray</STRONG> tool is most effective when used in combination with one of 
  62. 			the <STRONG>stencils </STRONG>- for example, by applying the <STRONG>Conflict 
  63. 				stencil</STRONG> and using the <STRONG>Spray</STRONG> tool, you can 
  64. 			simultaneously resolve all the conflicts in the image without harming the 
  65. 			non-conflicting portions.</P>
  66. 		<P><STRONG>Eraser: </STRONG>Allows you to selectively overwrite portions of the 
  67. 			merged image with a neutral color (the default is #FFFFFF00, or transparent 
  68. 			white).&nbsp; The color can be chosen in the <STRONG>Color options</STRONG> dialog.</P>
  69. 		<P><STRONG>Save:</STRONG> Saves the image.&nbsp; If you have not saved the image 
  70. 			yet, and you did not specify a "result" on the command line, you will be 
  71. 			prompted for a filename.</P>
  72. 		<P>&nbsp;</P>
  73. 		<H4><a name="menus">The CALAMARI menus</a></H4>
  74. 		<P><STRONG>File &gt; Save: </STRONG>Saves the image.</P>
  75. 		<P><STRONG>File &gt; Save As...: </STRONG>Prompts you for a new filename and saves 
  76. 			the image.</P>
  77. 		<P><STRONG>File &gt; Export Stencils:</STRONG> Saves the "base", "theirs", and 
  78. 			"conflict" stencils as black and white PNGs in the same location as the saved 
  79. 			merge image.</P>
  80. 		<P><STRONG>File &gt; Exit:</STRONG> Guess what this does.</P>
  81. 		<P><STRONG>View &gt; Diff Base vs Theirs...: </STRONG>Opens a new CALAMARI window 
  82. 			which diffs the "base" and "theirs" files.</P>
  83. 		<P><STRONG>View &gt; Diff Base vs Yours...: </STRONG>Opens a new CALAMARI window 
  84. 			which diffs the "base" and "yours" files.</P>
  85. 		<P><STRONG>Help &gt; CALAMARI Help: </STRONG>Brings you here.</P>
  86. 		<P><STRONG>Help &gt; About:</STRONG> A mildly informative blurb.</P>
  87. 		<P>&nbsp;</P>
  88. 		<H4><a name=window>The CALAMARI merge window</a></H4>
  89. 		<P><img src=qrc:/doc/help/merge-window.png></P>
  90. 		<P><STRONG>Theirs:</STRONG>&nbsp;The "theirs" file that you passed to 
  91. 			CALAMARI.&nbsp; As in diff mode, clicking on this image will set the slider to 
  92. 			the top position, and will scroll the merge editor to the clicked area if 
  93. 			appropriate.</P>
  94. 		<P><STRONG>Yours: </STRONG>As above, but with the "yours" file.</P>
  95. 		<P><STRONG>Slider: </STRONG>Sets the blend of colors that will be used by the <STRONG>Paint</STRONG>
  96. 			and <STRONG>Spray</STRONG> tools.&nbsp; Disabled if neither of those tools is 
  97. 			active.</P>
  98. 		<P><STRONG>Merge Editor: </STRONG>This is where you modify the merge result using 
  99. 			the <STRONG>Automerge</STRONG>, <STRONG>Paint</STRONG>, <STRONG>Spray</STRONG>, 
  100. 			and <STRONG>Erase</STRONG> tools.</P>
  101. 	</BODY>
  102. </HTML>
# Change User Description Committed
#1 5534 Sam Stafford A brand new help file, a bit of cosmetic sprucing, one critical bug
fix, and a partridge... in a pear tree. «		 19 years ago