GgitCloneOptions: libgit2-glib Reference Manual

## GgitCloneOptions GgitCloneOptions |

## Functions

GgitCloneOptions * | ggit_clone_options_new ()
gboolean | ggit_clone_options_get_is_bare ()
void | ggit_clone_options_set_is_bare ()
const gchar * | ggit_clone_options_get_checkout_branch ()
void | ggit_clone_options_set_checkout_branch ()
GgitCloneLocal | ggit_clone_options_get_local ()
void | ggit_clone_options_set_local ()
GgitFetchOptions * | ggit_clone_options_get_fetch_options ()
void | ggit_clone_options_set_fetch_options ()

## Types and Values

| GgitCloneOptions

## Object Hierarchy

        GObject
        ╰── GgitCloneOptions

## Description

## Functions

### ggit_clone_options_new ()

    GgitCloneOptions *
    ggit_clone_options_new (void);

Creates a new GgitCloneOptions.

#### Returns

a newly allocated GgitCloneOptions.

### ggit_clone_options_get_is_bare ()

    gboolean
    ggit_clone_options_get_is_bare (GgitCloneOptions *options);

Gets if the repository will be bare.

#### Parameters

options | a GgitCloneOptions. |

#### Returns

`TRUE` to clone a bare repository.

### ggit_clone_options_set_is_bare ()

    void
    ggit_clone_options_set_is_bare (GgitCloneOptions *options,
                                    gboolean bare);

Sets whether to clone a bare repository.

#### Parameters

options | a GgitCloneOptions. |
bare | `TRUE` to clone a bare repository. |

### ggit_clone_options_get_checkout_branch ()

    const gchar *
    ggit_clone_options_get_checkout_branch
                                   (GgitCloneOptions *options);

Gets the name of the branch to checkout or `NULL`.

#### Parameters

options | a GgitCloneOptions. |

#### Returns

the name of the branch to checkout or `NULL`.

### ggit_clone_options_set_checkout_branch ()

    void
    ggit_clone_options_set_checkout_branch
                                   (GgitCloneOptions *options,
                                    const gchar *checkout_branch);

Gives the name of the branch to checkout. `NULL` means use the remote's HEAD.

#### Parameters

options | a GgitCloneOptions. |
checkout_branch | the name of the branch to checkout or `NULL`. | [allow-none]

### ggit_clone_options_get_local ()

    GgitCloneLocal
    ggit_clone_options_get_local (GgitCloneOptions *options);

Get setting for bypassing the git-aware transport when cloning. The default auto setting bypasses the git-aware transport for local paths, but use a normal fetch for file:// URIs.

#### Parameters

options | a GgitCloneOptions. |

#### Returns

the local clone setting.

### ggit_clone_options_set_local ()

    void
    ggit_clone_options_set_local (GgitCloneOptions *options,
                                  GgitCloneLocal local);

Set setting for bypassing the git-aware transport when cloning. The default auto setting bypasses the git-aware transport for local paths, but use a normal fetch for file:// URIs.

#### Parameters

options | a GgitCloneOptions. |
local | the local clone setting. |

### ggit_clone_options_get_fetch_options ()

    GgitFetchOptions *
    ggit_clone_options_get_fetch_options (GgitCloneOptions *options);

Get the fetch options object or `NULL` if not set.

#### Parameters

options | a GgitCloneOptions. |

#### Returns

the fetch options or `NULL`.

[transfer none]

### ggit_clone_options_set_fetch_options ()

    void
    ggit_clone_options_set_fetch_options (GgitCloneOptions *options,
                                          GgitFetchOptions *fetch_options);

Set the fetch options object.

#### Parameters

options | a GgitCloneOptions. |
fetch_options | a GgitFetchOptions or `NULL`. | [allow-none]

## Types and Values

### GgitCloneOptions

    typedef struct _GgitCloneOptions GgitCloneOptions;

Represents the options used when cloning.