Ggit.RebaseOptions

Fields

None

Methods

class

new ()

copy ()

free ()

get_checkout_options ()

get_quiet ()

get_rewrite_notes_ref ()

set_checkout_options (checkout_options)

set_quiet (quiet)

set_rewrite_notes_ref (rewrite_notes_ref)

Details

class Ggit.RebaseOptions

Represents the options used when rebasing.

classmethod new()
Returns:

a newly allocated Ggit.RebaseOptions.

Return type:

Ggit.RebaseOptions

Creates a new Ggit.RebaseOptions.

copy()
Returns:

a newly allocated Ggit.RebaseOptions or None.

Return type:

Ggit.RebaseOptions or None

Copies self into a newly allocated Ggit.RebaseOptions.

free()

Frees self.

get_checkout_options()
Returns:

the checkout options or None.

Return type:

Ggit.CheckoutOptions or None

Get the checkout options object or None if not set.

get_quiet()
Returns:

returns whether you want a quiet rebase experience.

Return type:

bool

Gets whether you want a quiet rebase experience.

get_rewrite_notes_ref()
Returns:

the name of the notes reference or None.

Return type:

str or None

Gets the the name of the notes reference used to rewrite notes for rebased commits when finishing the rebase or None if not set.

set_checkout_options(checkout_options)
Parameters:

checkout_options (Ggit.CheckoutOptions) –

set_quiet(quiet)
Parameters:

quiet (bool) – whether you want a quiet rebase experience.

Used by ggit_rebase_init(), this will instruct other clients working on this rebase that you want a quiet rebase experience, which they may choose to provide in an application-specific manner. This has no effect upon libgit2-glib directly, but is provided for interoperability between Git tools.

set_rewrite_notes_ref(rewrite_notes_ref)
Parameters:

rewrite_notes_ref (str) – the name of the notes reference.

Used by Ggit.Rebase.finish(), this is the name of the notes reference used to rewrite notes for rebased commits when finishing the rebase; if None, the contents of the configuration option notes.rewriteRef is examined, unless the configuration option notes.rewrite.rebase is set to false. If notes.rewriteRef is also None, notes will not be rewritten.