Struct ExternalMergeTool

pub struct ExternalMergeTool {
    pub program: String,
    pub diff_args: Vec<String>,
    pub diff_expected_exit_codes: Vec<i32>,
    pub diff_invocation_mode: DiffToolMode,
    pub diff_do_chdir: bool,
    pub edit_args: Vec<String>,
    pub merge_args: Vec<String>,
    pub merge_conflict_exit_codes: Vec<i32>,
    pub merge_tool_edits_conflict_markers: bool,
    pub conflict_marker_style: Option<ConflictMarkerStyle>,
}

Merge/diff tool loaded from the settings.

Fields

program: String

Program to execute. Must be defined; defaults to the tool name if not specified in the config.

diff_args: Vec<String>

Arguments to pass to the program when generating diffs. $left and $right are replaced with the corresponding directories.

diff_expected_exit_codes: Vec<i32>

Exit codes to be treated as success when generating diffs.

diff_invocation_mode: DiffToolMode

Whether to execute the tool with a pair of directories or individual files.

diff_do_chdir: bool

Whether to execute the tool in the temporary diff directory

edit_args: Vec<String>

Arguments to pass to the program when editing diffs. $left and $right are replaced with the corresponding directories.

merge_args: Vec<String>

Arguments to pass to the program when resolving 3-way conflicts. $left, $right, $base, and $output are replaced with paths to the corresponding files.

merge_conflict_exit_codes: Vec<i32>

By default, if a merge tool exits with a non-zero exit code, then the merge will be cancelled. Some merge tools allow leaving some conflicts unresolved, in which case they will be left as conflict markers in the output file. In that case, the merge tool may exit with a non-zero exit code to indicate that not all conflicts were resolved. Adding an exit code to this array will tell jj to interpret that exit code as indicating that the $output file should contain conflict markers.

merge_tool_edits_conflict_markers: bool

If false (default), the $output file starts out empty and is accepted as a full conflict resolution as-is by jj after the merge tool is done with it. If true, the $output file starts out with the contents of the conflict, with the configured conflict markers. After the merge tool is done, any remaining conflict markers in the file are parsed and taken to mean that the conflict was only partially resolved.

conflict_marker_style: Option<ConflictMarkerStyle>

If provided, overrides the normal conflict marker style setting. This is useful if a tool parses conflict markers, and so it requires a specific format, or if a certain format is more readable than another.

Implementations

impl ExternalMergeTool

pub fn with_program(program: impl Into<String>) -> Self

pub fn with_diff_args(command_args: &CommandNameAndArgs) -> Self

pub fn with_edit_args(command_args: &CommandNameAndArgs) -> Self

pub fn with_merge_args(command_args: &CommandNameAndArgs) -> Self

Trait Implementations

impl Clone for ExternalMergeTool

fn clone(&self) -> ExternalMergeTool

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExternalMergeTool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ExternalMergeTool

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExternalMergeTool

where ExternalMergeTool: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ExternalMergeTool

fn eq(&self, other: &ExternalMergeTool) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ExternalMergeTool

impl StructuralPartialEq for ExternalMergeTool