github.com/jbendotnet/noms@v0.0.0-20190904222105-c43e4293ea92/go/datas/commit_options.go (about)

     1  // Copyright 2016 Attic Labs, Inc. All rights reserved.
     2  // Licensed under the Apache License, version 2.0:
     3  // http://www.apache.org/licenses/LICENSE-2.0
     4  
     5  package datas
     6  
     7  import (
     8  	"github.com/attic-labs/noms/go/merge"
     9  	"github.com/attic-labs/noms/go/types"
    10  )
    11  
    12  // CommitOptions is used to pass options into Commit.
    13  type CommitOptions struct {
    14  	// Parents, if provided is the parent commits of the commit we are
    15  	// creating.
    16  	Parents types.Set
    17  
    18  	// Meta is a Struct that describes arbitrary metadata about this Commit,
    19  	// e.g. a timestamp or descriptive text.
    20  	Meta types.Struct
    21  
    22  	// Policy will be called to attempt to merge this Commit with the current
    23  	// Head, if this is not a fast-forward. If Policy is nil, no merging will
    24  	// be attempted. Note that because Commit() retries in some cases, Policy
    25  	// might also be called multiple times with different values.
    26  	Policy merge.Policy
    27  }