<HTML> <HEAD> <TITLE></TITLE> <META NAME="GENERATOR" Content="Microsoft Visual Studio .NET 7.1"> </HEAD> <BODY> <H3>Merging with CALAMARI</H3> <UL> <LI> <a href="#how">How CALAMARI merges files</a> <LI> <a href="#cli">Calling CALAMARI from the command line</a> <LI> <a href="#toolbar">The CALAMARI merge toolbar</a> <LI> <a href="#menus">The CALAMARI menus</a> <LI> <a href="#window">The CALAMARI merge window</a></LI></UL> <P> </P> <H4><a name="how">How CALAMARI merges files</a></H4> <P>A "three-way merge" is based on the concept of two files having "diffs" from a base (common ancestor) file, and the ability to combine those diffs into a new single file. The below example illustrates a base file having two changes made to it, and those two changes being merged together:</P> <P><img src="qrc:/doc/help/merge-how.png"></P> <P>See "<a href="qrc:/doc/help/diffing.html#how">How CALAMARI diffs files</a>" for more on how the diffs are determined.</P> <P> </P> <H4><a name="cli"></a>Calling CALAMARI from the command line</A></H4> <P>To merge files in CALAMARI, call <STRONG>calamari </STRONG>with the names of the "base," "theirs," and "yours" files as arguments. You can optionally specify the "result" file that the merge will be saved as; if you do not specify a result filename, you will be prompted for one when you save.</P> <P><STRONG>calamari base.png theirs.png yours.png [result.png]</STRONG></P> <P> </P> <H4><a name="toolbar">The CALAMARI merge toolbar</a></H4> <P><img src="qrc:/doc/help/merge-toolbar.png"></P> <P><STRONG>Theirs stencil:</STRONG> Applies a "stencil" over the merge editor, both obscuring parts of the result that do not correspond to diffs in the "theirs" file, and preventing those parts from being painted over.</P> <P><STRONG>Yours stencil:</STRONG> Like the <STRONG>Theirs stencil</STRONG>, but corresponds to diffs in the "yours" file.</P> <P><STRONG>Conflict stencil:</STRONG> Like the other two stencils, but corresponds to conflicting diffs (usually the intersection of the "yours" and "theirs" diffs).</P> <P><STRONG>Color options:</STRONG> Allows you to set the color of the stencils, the color that <STRONG>Automerge</STRONG> paints conflicts with, the color that the <STRONG> Eraser</STRONG> replaces the image with, and the threshold at which color differences are considered to be "diffs".</P> <P><STRONG>Zoom: </STRONG>Allows you to set the zoom level of the merge editor.</P> <P><STRONG>Automerge: </STRONG>Automatically merges the entire file by accepting all non-conflicting diffs from both "theirs" and "yours". Conflicts will be painted with the "conflict color" set in <STRONG>Color Options</STRONG>, and should be replaced with "theirs" or "yours" before saving.</P> <P><STRONG>Paint: </STRONG>Allows you to selectively paint in the merge editor with colors taken from the "theirs" file, the "yours" file, or a blend of the two. The <STRONG>slider</STRONG> determines which of the two images you will use.</P> <P><STRONG>Spray:</STRONG> Like the <STRONG>Paint</STRONG> tool, but it is automatically applied to the entire image as the slider is moved. The <STRONG> Spray</STRONG> tool is most effective when used in combination with one of the <STRONG>stencils </STRONG>- for example, by applying the <STRONG>Conflict stencil</STRONG> and using the <STRONG>Spray</STRONG> tool, you can simultaneously resolve all the conflicts in the image without harming the non-conflicting portions.</P> <P><STRONG>Eraser: </STRONG>Allows you to selectively overwrite portions of the merged image with a neutral color (the default is #FFFFFF00, or transparent white). The color can be chosen in the <STRONG>Color options</STRONG> dialog.</P> <P><STRONG>Save:</STRONG> Saves the image. If you have not saved the image yet, and you did not specify a "result" on the command line, you will be prompted for a filename.</P> <P> </P> <H4><a name="menus">The CALAMARI menus</a></H4> <P><STRONG>File > Save: </STRONG>Saves the image.</P> <P><STRONG>File > Save As...: </STRONG>Prompts you for a new filename and saves the image.</P> <P><STRONG>File > Export Stencils:</STRONG> Saves the "base", "theirs", and "conflict" stencils as black and white PNGs in the same location as the saved merge image.</P> <P><STRONG>File > Exit:</STRONG> Guess what this does.</P> <P><STRONG>View > Diff Base vs Theirs...: </STRONG>Opens a new CALAMARI window which diffs the "base" and "theirs" files.</P> <P><STRONG>View > Diff Base vs Yours...: </STRONG>Opens a new CALAMARI window which diffs the "base" and "yours" files.</P> <P><STRONG>Help > CALAMARI Help: </STRONG>Brings you here.</P> <P><STRONG>Help > About:</STRONG> A mildly informative blurb.</P> <P> </P> <H4><a name=window>The CALAMARI merge window</a></H4> <P><img src=qrc:/doc/help/merge-window.png></P> <P><STRONG>Theirs:</STRONG> The "theirs" file that you passed to CALAMARI. As in diff mode, clicking on this image will set the slider to the top position, and will scroll the merge editor to the clicked area if appropriate.</P> <P><STRONG>Yours: </STRONG>As above, but with the "yours" file.</P> <P><STRONG>Slider: </STRONG>Sets the blend of colors that will be used by the <STRONG>Paint</STRONG> and <STRONG>Spray</STRONG> tools. Disabled if neither of those tools is active.</P> <P><STRONG>Merge Editor: </STRONG>This is where you modify the merge result using the <STRONG>Automerge</STRONG>, <STRONG>Paint</STRONG>, <STRONG>Spray</STRONG>, and <STRONG>Erase</STRONG> tools.</P> </BODY> </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. |