diff3

README

diff3

Package diff3 implements a three-way merge algorithm Original version in Javascript by Bryan Housel @bhousel: https://github.com/bhousel/node-diff3, which in turn is based on project Synchrotron, created by Tony Garnock-Jones. For more detail please visit: http://homepages.kcbbs.gen.nz/tonyg/projects/synchrotron.html https://github.com/tonyg/synchrotron

Ported to go by Javier Peletier @jpeletier

How to use:

Import the package and call Merge:

Merge(a, o, b io.Reader, detailed bool, labelA string, labelB string) (*MergeResult, error)

Where:

• a and b are the current and incoming versions of content
• o is the common ancestor
• detailed specifies whether you want the merge conflicts to be detailed.
• labelA and labelB indicate a label to mark conflicts with, usually the branch names.

Returns a MergeResult that includes a flag indicating whether there were conflicts or not and a io.Reader stream with the result.

Documentation

Overview

Package diff3 implements a three-way merge algorithm Original version in Javascript by Bryan Housel @bhousel: https://github.com/bhousel/node-diff3, which in turn is based on project Synchrotron, created by Tony Garnock-Jones. For more detail please visit: http://homepages.kcbbs.gen.nz/tonyg/projects/synchrotron.html https://github.com/tonyg/synchrotron

Ported to go by Javier Peletier @jpeletier

Index

• type Conflict
• type Diff3MergeResult
  • func Diff3Merge(a, o, b []string, excludeFalseConflicts bool) []*Diff3MergeResult
• type MergeResult
  • func Merge(a, o, b io.Reader, detailed bool, labelA string, labelB string) (*MergeResult, error)

Types

type Conflict

type Conflict struct {
	// contains filtered or unexported fields
}

Conflict describes a merge conflict

type Diff3MergeResult

type Diff3MergeResult struct {
	// contains filtered or unexported fields
}

Diff3MergeResult describes a merge result

func Diff3Merge

func Diff3Merge(a, o, b []string, excludeFalseConflicts bool) []*Diff3MergeResult

Diff3Merge applies the output of diff3MergeIndices to actually construct the merged file; the returned result alternates between 'ok' and 'conflict' blocks.

type MergeResult

type MergeResult struct {
	Conflicts bool      //Conflict indicates if there is any merge conflict
	Result    io.Reader // returns a reader that contains the merge result
}

MergeResult describes a merge result

func Merge

func Merge(a, o, b io.Reader, detailed bool, labelA string, labelB string) (*MergeResult, error)

Merge takes three streams and returns the merged result