2 * Copyright (C) the libgit2 contributors. All rights reserved.
4 * This file is part of libgit2, distributed under the GNU GPL v2 with
5 * a Linking Exception. For full terms see the included COPYING file.
7 #ifndef INCLUDE_git_remote_h__
8 #define INCLUDE_git_remote_h__
11 #include "repository.h"
16 #include "transport.h"
22 * @brief Git remote management functions
23 * @defgroup git_remote remote management functions
30 * Add a remote with the default fetch refspec to the repository's configuration.
32 * @param out the resulting remote
33 * @param repo the repository in which to create the remote
34 * @param name the remote's name
35 * @param url the remote's url
36 * @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code
38 GIT_EXTERN(int) git_remote_create(
45 * Remote creation options flags
48 /** Ignore the repository apply.insteadOf configuration */
49 GIT_REMOTE_CREATE_SKIP_INSTEADOF
= (1 << 0),
51 /** Don't build a fetchspec from the name if none is set */
52 GIT_REMOTE_CREATE_SKIP_DEFAULT_FETCHSPEC
= (1 << 1),
53 } git_remote_create_flags
;
56 * Remote creation options structure
58 * Initialize with `GIT_REMOTE_CREATE_OPTIONS_INIT`. Alternatively, you can
59 * use `git_remote_create_options_init`.
62 typedef struct git_remote_create_options
{
66 * The repository that should own the remote.
67 * Setting this to NULL results in a detached remote.
69 git_repository
*repository
;
73 * Setting this to NULL results in an in-memory/anonymous remote.
77 /** The fetchspec the remote should use. */
78 const char *fetchspec
;
80 /** Additional flags for the remote. See git_remote_create_flags. */
82 } git_remote_create_options
;
84 #define GIT_REMOTE_CREATE_OPTIONS_VERSION 1
85 #define GIT_REMOTE_CREATE_OPTIONS_INIT {GIT_REMOTE_CREATE_OPTIONS_VERSION}
88 * Initialize git_remote_create_options structure
90 * Initializes a `git_remote_create_options` with default values. Equivalent to
91 * creating an instance with `GIT_REMOTE_CREATE_OPTIONS_INIT`.
93 * @param opts The `git_remote_create_options` struct to initialize.
94 * @param version The struct version; pass `GIT_REMOTE_CREATE_OPTIONS_VERSION`.
95 * @return Zero on success; -1 on failure.
97 GIT_EXTERN(int) git_remote_create_options_init(
98 git_remote_create_options
*opts
,
99 unsigned int version
);
102 * Create a remote, with options.
104 * This function allows more fine-grained control over the remote creation.
106 * Passing NULL as the opts argument will result in a detached remote.
108 * @param out the resulting remote
109 * @param url the remote's url
110 * @param opts the remote creation options
111 * @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code
113 GIT_EXTERN(int) git_remote_create_with_opts(
116 const git_remote_create_options
*opts
);
119 * Add a remote with the provided fetch refspec (or default if NULL) to the repository's
122 * @param out the resulting remote
123 * @param repo the repository in which to create the remote
124 * @param name the remote's name
125 * @param url the remote's url
126 * @param fetch the remote fetch value
127 * @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code
129 GIT_EXTERN(int) git_remote_create_with_fetchspec(
131 git_repository
*repo
,
137 * Create an anonymous remote
139 * Create a remote with the given url in-memory. You can use this when
140 * you have a URL instead of a remote's name.
142 * @param out pointer to the new remote objects
143 * @param repo the associated repository
144 * @param url the remote repository's URL
145 * @return 0 or an error code
147 GIT_EXTERN(int) git_remote_create_anonymous(
149 git_repository
*repo
,
153 * Create a remote without a connected local repo
155 * Create a remote with the given url in-memory. You can use this when
156 * you have a URL instead of a remote's name.
158 * Contrasted with git_remote_create_anonymous, a detached remote
159 * will not consider any repo configuration values (such as insteadof url
162 * @param out pointer to the new remote objects
163 * @param url the remote repository's URL
164 * @return 0 or an error code
166 GIT_EXTERN(int) git_remote_create_detached(
171 * Get the information for a particular remote
173 * The name will be checked for validity.
174 * See `git_tag_create()` for rules about valid names.
176 * @param out pointer to the new remote object
177 * @param repo the associated repository
178 * @param name the remote's name
179 * @return 0, GIT_ENOTFOUND, GIT_EINVALIDSPEC or an error code
181 GIT_EXTERN(int) git_remote_lookup(git_remote
**out
, git_repository
*repo
, const char *name
);
184 * Create a copy of an existing remote. All internal strings are also
185 * duplicated. Callbacks are not duplicated.
187 * Call `git_remote_free` to free the data.
189 * @param dest pointer where to store the copy
190 * @param source object to copy
191 * @return 0 or an error code
193 GIT_EXTERN(int) git_remote_dup(git_remote
**dest
, git_remote
*source
);
196 * Get the remote's repository
198 * @param remote the remote
199 * @return a pointer to the repository
201 GIT_EXTERN(git_repository
*) git_remote_owner(const git_remote
*remote
);
204 * Get the remote's name
206 * @param remote the remote
207 * @return a pointer to the name or NULL for in-memory remotes
209 GIT_EXTERN(const char *) git_remote_name(const git_remote
*remote
);
212 * Get the remote's url
214 * If url.*.insteadOf has been configured for this URL, it will
215 * return the modified URL.
217 * @param remote the remote
218 * @return a pointer to the url
220 GIT_EXTERN(const char *) git_remote_url(const git_remote
*remote
);
223 * Get the remote's url for pushing
225 * If url.*.pushInsteadOf has been configured for this URL, it
226 * will return the modified URL.
228 * @param remote the remote
229 * @return a pointer to the url or NULL if no special url for pushing is set
231 GIT_EXTERN(const char *) git_remote_pushurl(const git_remote
*remote
);
234 * Set the remote's url in the configuration
236 * Remote objects already in memory will not be affected. This assumes
237 * the common case of a single-url remote and will otherwise return an error.
239 * @param repo the repository in which to perform the change
240 * @param remote the remote's name
241 * @param url the url to set
242 * @return 0 or an error value
244 GIT_EXTERN(int) git_remote_set_url(git_repository
*repo
, const char *remote
, const char* url
);
247 * Set the remote's url for pushing in the configuration.
249 * Remote objects already in memory will not be affected. This assumes
250 * the common case of a single-url remote and will otherwise return an error.
253 * @param repo the repository in which to perform the change
254 * @param remote the remote's name
255 * @param url the url to set
257 GIT_EXTERN(int) git_remote_set_pushurl(git_repository
*repo
, const char *remote
, const char* url
);
260 * Add a fetch refspec to the remote's configuration
262 * Add the given refspec to the fetch list in the configuration. No
263 * loaded remote instances will be affected.
265 * @param repo the repository in which to change the configuration
266 * @param remote the name of the remote to change
267 * @param refspec the new fetch refspec
268 * @return 0, GIT_EINVALIDSPEC if refspec is invalid or an error value
270 GIT_EXTERN(int) git_remote_add_fetch(git_repository
*repo
, const char *remote
, const char *refspec
);
273 * Get the remote's list of fetch refspecs
275 * The memory is owned by the user and should be freed with
276 * `git_strarray_free`.
278 * @param array pointer to the array in which to store the strings
279 * @param remote the remote to query
281 GIT_EXTERN(int) git_remote_get_fetch_refspecs(git_strarray
*array
, const git_remote
*remote
);
284 * Add a push refspec to the remote's configuration
286 * Add the given refspec to the push list in the configuration. No
287 * loaded remote instances will be affected.
289 * @param repo the repository in which to change the configuration
290 * @param remote the name of the remote to change
291 * @param refspec the new push refspec
292 * @return 0, GIT_EINVALIDSPEC if refspec is invalid or an error value
294 GIT_EXTERN(int) git_remote_add_push(git_repository
*repo
, const char *remote
, const char *refspec
);
297 * Get the remote's list of push refspecs
299 * The memory is owned by the user and should be freed with
300 * `git_strarray_free`.
302 * @param array pointer to the array in which to store the strings
303 * @param remote the remote to query
305 GIT_EXTERN(int) git_remote_get_push_refspecs(git_strarray
*array
, const git_remote
*remote
);
308 * Get the number of refspecs for a remote
310 * @param remote the remote
311 * @return the amount of refspecs configured in this remote
313 GIT_EXTERN(size_t) git_remote_refspec_count(const git_remote
*remote
);
316 * Get a refspec from the remote
318 * @param remote the remote to query
319 * @param n the refspec to get
320 * @return the nth refspec
322 GIT_EXTERN(const git_refspec
*)git_remote_get_refspec(const git_remote
*remote
, size_t n
);
325 * Open a connection to a remote
327 * The transport is selected based on the URL. The direction argument
328 * is due to a limitation of the git protocol (over TCP or SSH) which
329 * starts up a specific binary which can only do the one or the other.
331 * @param remote the remote to connect to
332 * @param direction GIT_DIRECTION_FETCH if you want to fetch or
333 * GIT_DIRECTION_PUSH if you want to push
334 * @param callbacks the callbacks to use for this connection
335 * @param proxy_opts proxy settings
336 * @param custom_headers extra HTTP headers to use in this connection
337 * @return 0 or an error code
339 GIT_EXTERN(int) git_remote_connect(git_remote
*remote
, git_direction direction
, const git_remote_callbacks
*callbacks
, const git_proxy_options
*proxy_opts
, const git_strarray
*custom_headers
);
342 * Get the remote repository's reference advertisement list
344 * Get the list of references with which the server responds to a new
347 * The remote (or more exactly its transport) must have connected to
348 * the remote repository. This list is available as soon as the
349 * connection to the remote is initiated and it remains available
350 * after disconnecting.
352 * The memory belongs to the remote. The pointer will be valid as long
353 * as a new connection is not initiated, but it is recommended that
354 * you make a copy in order to make use of the data.
356 * @param out pointer to the array
357 * @param size the number of remote heads
358 * @param remote the remote
359 * @return 0 on success, or an error code
361 GIT_EXTERN(int) git_remote_ls(const git_remote_head
***out
, size_t *size
, git_remote
*remote
);
364 * Check whether the remote is connected
366 * Check whether the remote's underlying transport is connected to the
369 * @param remote the remote
370 * @return 1 if it's connected, 0 otherwise.
372 GIT_EXTERN(int) git_remote_connected(const git_remote
*remote
);
375 * Cancel the operation
377 * At certain points in its operation, the network code checks whether
378 * the operation has been cancelled and if so stops the operation.
380 * @param remote the remote
381 * @return 0 on success, or an error code
383 GIT_EXTERN(int) git_remote_stop(git_remote
*remote
);
386 * Disconnect from the remote
388 * Close the connection to the remote.
390 * @param remote the remote to disconnect from
391 * @return 0 on success, or an error code
393 GIT_EXTERN(int) git_remote_disconnect(git_remote
*remote
);
396 * Free the memory associated with a remote
398 * This also disconnects from the remote, if the connection
399 * has not been closed yet (using git_remote_disconnect).
401 * @param remote the remote to free
403 GIT_EXTERN(void) git_remote_free(git_remote
*remote
);
406 * Get a list of the configured remotes for a repo
408 * The string array must be freed by the user.
410 * @param out a string array which receives the names of the remotes
411 * @param repo the repository to query
412 * @return 0 or an error code
414 GIT_EXTERN(int) git_remote_list(git_strarray
*out
, git_repository
*repo
);
417 * Argument to the completion callback which tells it which operation
420 typedef enum git_remote_completion_t
{
421 GIT_REMOTE_COMPLETION_DOWNLOAD
,
422 GIT_REMOTE_COMPLETION_INDEXING
,
423 GIT_REMOTE_COMPLETION_ERROR
,
424 } git_remote_completion_t
;
426 /** Push network progress notification function */
427 typedef int GIT_CALLBACK(git_push_transfer_progress_cb
)(
428 unsigned int current
,
434 * Represents an update which will be performed on the remote during push
438 * The source name of the reference
442 * The name of the reference to update on the server
446 * The current target of the reference
450 * The new target for the reference
456 * Callback used to inform of upcoming updates.
458 * @param updates an array containing the updates which will be sent
459 * as commands to the destination.
460 * @param len number of elements in `updates`
461 * @param payload Payload provided by the caller
463 typedef int GIT_CALLBACK(git_push_negotiation
)(const git_push_update
**updates
, size_t len
, void *payload
);
466 * Callback used to inform of the update status from the remote.
468 * Called for each updated reference on push. If `status` is
469 * not `NULL`, the update was rejected by the remote server
470 * and `status` contains the reason given.
472 * @param refname refname specifying to the remote ref
473 * @param status status message sent from the remote
474 * @param data data provided by the caller
475 * @return 0 on success, otherwise an error
477 typedef int GIT_CALLBACK(git_push_update_reference_cb
)(const char *refname
, const char *status
, void *data
);
480 * Callback to resolve URLs before connecting to remote
482 * If you return GIT_PASSTHROUGH, you don't need to write anything to
485 * @param url_resolved The buffer to write the resolved URL to
486 * @param url The URL to resolve
487 * @param direction GIT_DIRECTION_FETCH or GIT_DIRECTION_PUSH
488 * @param payload Payload provided by the caller
489 * @return 0 on success, GIT_PASSTHROUGH or an error
491 typedef int GIT_CALLBACK(git_url_resolve_cb
)(git_buf
*url_resolved
, const char *url
, int direction
, void *payload
);
494 * The callback settings structure
496 * Set the callbacks to be called by the remote when informing the user
497 * about the progress of the network operations.
499 struct git_remote_callbacks
{
500 unsigned int version
; /**< The version */
503 * Textual progress from the remote. Text send over the
504 * progress side-band will be passed to this function (this is
505 * the 'counting objects' output).
507 git_transport_message_cb sideband_progress
;
510 * Completion is called when different parts of the download
511 * process are done (currently unused).
513 int GIT_CALLBACK(completion
)(git_remote_completion_t type
, void *data
);
516 * This will be called if the remote host requires
517 * authentication in order to connect to it.
519 * Returning GIT_PASSTHROUGH will make libgit2 behave as
520 * though this field isn't set.
522 git_credential_acquire_cb credentials
;
525 * If cert verification fails, this will be called to let the
526 * user make the final decision of whether to allow the
527 * connection to proceed. Returns 0 to allow the connection
528 * or a negative value to indicate an error.
530 git_transport_certificate_check_cb certificate_check
;
533 * During the download of new data, this will be regularly
534 * called with the current count of progress done by the
537 git_indexer_progress_cb transfer_progress
;
540 * Each time a reference is updated locally, this function
541 * will be called with information about it.
543 int GIT_CALLBACK(update_tips
)(const char *refname
, const git_oid
*a
, const git_oid
*b
, void *data
);
546 * Function to call with progress information during pack
547 * building. Be aware that this is called inline with pack
548 * building operations, so performance may be affected.
550 git_packbuilder_progress pack_progress
;
553 * Function to call with progress information during the
554 * upload portion of a push. Be aware that this is called
555 * inline with pack building operations, so performance may be
558 git_push_transfer_progress_cb push_transfer_progress
;
561 * See documentation of git_push_update_reference_cb
563 git_push_update_reference_cb push_update_reference
;
566 * Called once between the negotiation step and the upload. It
567 * provides information about what updates will be performed.
569 git_push_negotiation push_negotiation
;
572 * Create the transport to use for this operation. Leave NULL
575 git_transport_cb transport
;
578 * This will be passed to each of the callbacks in this struct
579 * as the last parameter.
584 * Resolve URL before connecting to remote.
585 * The returned URL will be used to connect to the remote instead.
587 git_url_resolve_cb resolve_url
;
590 #define GIT_REMOTE_CALLBACKS_VERSION 1
591 #define GIT_REMOTE_CALLBACKS_INIT {GIT_REMOTE_CALLBACKS_VERSION}
594 * Initializes a `git_remote_callbacks` with default values. Equivalent to
595 * creating an instance with GIT_REMOTE_CALLBACKS_INIT.
597 * @param opts the `git_remote_callbacks` struct to initialize
598 * @param version Version of struct; pass `GIT_REMOTE_CALLBACKS_VERSION`
599 * @return Zero on success; -1 on failure.
601 GIT_EXTERN(int) git_remote_init_callbacks(
602 git_remote_callbacks
*opts
,
603 unsigned int version
);
605 /** Acceptable prune settings when fetching */
608 * Use the setting from the configuration
610 GIT_FETCH_PRUNE_UNSPECIFIED
,
622 * Automatic tag following option
624 * Lets us select the --tags option to use.
628 * Use the setting from the configuration.
630 GIT_REMOTE_DOWNLOAD_TAGS_UNSPECIFIED
= 0,
632 * Ask the server for tags pointing to objects we're already
635 GIT_REMOTE_DOWNLOAD_TAGS_AUTO
,
637 * Don't ask for any tags beyond the refspecs.
639 GIT_REMOTE_DOWNLOAD_TAGS_NONE
,
641 * Ask for the all the tags.
643 GIT_REMOTE_DOWNLOAD_TAGS_ALL
,
644 } git_remote_autotag_option_t
;
647 * Fetch options structure.
649 * Zero out for defaults. Initialize with `GIT_FETCH_OPTIONS_INIT` macro to
650 * correctly set the `version` field. E.g.
652 * git_fetch_options opts = GIT_FETCH_OPTIONS_INIT;
658 * Callbacks to use for this fetch operation
660 git_remote_callbacks callbacks
;
663 * Whether to perform a prune after the fetch
665 git_fetch_prune_t prune
;
668 * Whether to write the results to FETCH_HEAD. Defaults to
669 * on. Leave this default in order to behave like git.
671 int update_fetchhead
;
674 * Determines how to behave regarding tags on the remote, such
675 * as auto-downloading tags for objects we're downloading or
676 * downloading all of them.
678 * The default is to auto-follow tags.
680 git_remote_autotag_option_t download_tags
;
683 * Proxy options to use, by default no proxy is used.
685 git_proxy_options proxy_opts
;
688 * Extra headers for this fetch operation
690 git_strarray custom_headers
;
693 #define GIT_FETCH_OPTIONS_VERSION 1
694 #define GIT_FETCH_OPTIONS_INIT { GIT_FETCH_OPTIONS_VERSION, GIT_REMOTE_CALLBACKS_INIT, GIT_FETCH_PRUNE_UNSPECIFIED, 1, \
695 GIT_REMOTE_DOWNLOAD_TAGS_UNSPECIFIED, GIT_PROXY_OPTIONS_INIT }
698 * Initialize git_fetch_options structure
700 * Initializes a `git_fetch_options` with default values. Equivalent to
701 * creating an instance with `GIT_FETCH_OPTIONS_INIT`.
703 * @param opts The `git_fetch_options` struct to initialize.
704 * @param version The struct version; pass `GIT_FETCH_OPTIONS_VERSION`.
705 * @return Zero on success; -1 on failure.
707 GIT_EXTERN(int) git_fetch_options_init(
708 git_fetch_options
*opts
,
709 unsigned int version
);
713 * Controls the behavior of a git_push object.
716 unsigned int version
;
719 * If the transport being used to push to the remote requires the creation
720 * of a pack file, this controls the number of worker threads used by
721 * the packbuilder when creating that pack file to be sent to the remote.
723 * If set to 0, the packbuilder will auto-detect the number of threads
724 * to create. The default value is 1.
726 unsigned int pb_parallelism
;
729 * Callbacks to use for this push operation
731 git_remote_callbacks callbacks
;
734 * Proxy options to use, by default no proxy is used.
736 git_proxy_options proxy_opts
;
739 * Extra headers for this push operation
741 git_strarray custom_headers
;
744 #define GIT_PUSH_OPTIONS_VERSION 1
745 #define GIT_PUSH_OPTIONS_INIT { GIT_PUSH_OPTIONS_VERSION, 1, GIT_REMOTE_CALLBACKS_INIT, GIT_PROXY_OPTIONS_INIT }
748 * Initialize git_push_options structure
750 * Initializes a `git_push_options` with default values. Equivalent to
751 * creating an instance with `GIT_PUSH_OPTIONS_INIT`.
753 * @param opts The `git_push_options` struct to initialize.
754 * @param version The struct version; pass `GIT_PUSH_OPTIONS_VERSION`.
755 * @return Zero on success; -1 on failure.
757 GIT_EXTERN(int) git_push_options_init(
758 git_push_options
*opts
,
759 unsigned int version
);
762 * Download and index the packfile
764 * Connect to the remote if it hasn't been done yet, negotiate with
765 * the remote git which objects are missing, download and index the
768 * The .idx file will be created and both it and the packfile with be
769 * renamed to their final name.
771 * @param remote the remote
772 * @param refspecs the refspecs to use for this negotiation and
773 * download. Use NULL or an empty array to use the base refspecs
774 * @param opts the options to use for this fetch
775 * @return 0 or an error code
777 GIT_EXTERN(int) git_remote_download(git_remote
*remote
, const git_strarray
*refspecs
, const git_fetch_options
*opts
);
780 * Create a packfile and send it to the server
782 * Connect to the remote if it hasn't been done yet, negotiate with
783 * the remote git which objects are missing, create a packfile with the missing objects and send it.
785 * @param remote the remote
786 * @param refspecs the refspecs to use for this negotiation and
787 * upload. Use NULL or an empty array to use the base refspecs
788 * @param opts the options to use for this push
789 * @return 0 or an error code
791 GIT_EXTERN(int) git_remote_upload(git_remote
*remote
, const git_strarray
*refspecs
, const git_push_options
*opts
);
794 * Update the tips to the new state
796 * @param remote the remote to update
797 * @param reflog_message The message to insert into the reflogs. If
798 * NULL and fetching, the default is "fetch <name>", where <name> is
799 * the name of the remote (or its url, for in-memory remotes). This
800 * parameter is ignored when pushing.
801 * @param callbacks pointer to the callback structure to use
802 * @param update_fetchhead whether to write to FETCH_HEAD. Pass 1 to behave like git.
803 * @param download_tags what the behaviour for downloading tags is for this fetch. This is
804 * ignored for push. This must be the same value passed to `git_remote_download()`.
805 * @return 0 or an error code
807 GIT_EXTERN(int) git_remote_update_tips(
809 const git_remote_callbacks
*callbacks
,
810 int update_fetchhead
,
811 git_remote_autotag_option_t download_tags
,
812 const char *reflog_message
);
815 * Download new data and update tips
817 * Convenience function to connect to a remote, download the data,
818 * disconnect and update the remote-tracking branches.
820 * @param remote the remote to fetch from
821 * @param refspecs the refspecs to use for this fetch. Pass NULL or an
822 * empty array to use the base refspecs.
823 * @param opts options to use for this fetch
824 * @param reflog_message The message to insert into the reflogs. If NULL, the
826 * @return 0 or an error code
828 GIT_EXTERN(int) git_remote_fetch(
830 const git_strarray
*refspecs
,
831 const git_fetch_options
*opts
,
832 const char *reflog_message
);
835 * Prune tracking refs that are no longer present on remote
837 * @param remote the remote to prune
838 * @param callbacks callbacks to use for this prune
839 * @return 0 or an error code
841 GIT_EXTERN(int) git_remote_prune(git_remote
*remote
, const git_remote_callbacks
*callbacks
);
846 * Peform all the steps from a push.
848 * @param remote the remote to push to
849 * @param refspecs the refspecs to use for pushing. If NULL or an empty
850 * array, the configured refspecs will be used
851 * @param opts options to use for this push
853 GIT_EXTERN(int) git_remote_push(git_remote
*remote
,
854 const git_strarray
*refspecs
,
855 const git_push_options
*opts
);
858 * Get the statistics structure that is filled in by the fetch operation.
860 GIT_EXTERN(const git_indexer_progress
*) git_remote_stats(git_remote
*remote
);
863 * Retrieve the tag auto-follow setting
865 * @param remote the remote to query
866 * @return the auto-follow setting
868 GIT_EXTERN(git_remote_autotag_option_t
) git_remote_autotag(const git_remote
*remote
);
871 * Set the remote's tag following setting.
873 * The change will be made in the configuration. No loaded remotes
876 * @param repo the repository in which to make the change
877 * @param remote the name of the remote
878 * @param value the new value to take.
880 GIT_EXTERN(int) git_remote_set_autotag(git_repository
*repo
, const char *remote
, git_remote_autotag_option_t value
);
882 * Retrieve the ref-prune setting
884 * @param remote the remote to query
885 * @return the ref-prune setting
887 GIT_EXTERN(int) git_remote_prune_refs(const git_remote
*remote
);
890 * Give the remote a new name
892 * All remote-tracking branches and configuration settings
893 * for the remote are updated.
895 * The new name will be checked for validity.
896 * See `git_tag_create()` for rules about valid names.
898 * No loaded instances of a the remote with the old name will change
899 * their name or their list of refspecs.
901 * @param problems non-default refspecs cannot be renamed and will be
902 * stored here for further processing by the caller. Always free this
903 * strarray on successful return.
904 * @param repo the repository in which to rename
905 * @param name the current name of the remote
906 * @param new_name the new name the remote should bear
907 * @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code
909 GIT_EXTERN(int) git_remote_rename(
910 git_strarray
*problems
,
911 git_repository
*repo
,
913 const char *new_name
);
916 * Ensure the remote name is well-formed.
918 * @param remote_name name to be checked.
919 * @return 1 if the reference name is acceptable; 0 if it isn't
921 GIT_EXTERN(int) git_remote_is_valid_name(const char *remote_name
);
924 * Delete an existing persisted remote.
926 * All remote-tracking branches and configuration settings
927 * for the remote will be removed.
929 * @param repo the repository in which to act
930 * @param name the name of the remote to delete
931 * @return 0 on success, or an error code.
933 GIT_EXTERN(int) git_remote_delete(git_repository
*repo
, const char *name
);
936 * Retrieve the name of the remote's default branch
938 * The default branch of a repository is the branch which HEAD points
939 * to. If the remote does not support reporting this information
940 * directly, it performs the guess as git does; that is, if there are
941 * multiple branches which point to the same commit, the first one is
942 * chosen. If the master branch is a candidate, it wins.
944 * This function must only be called after connecting.
946 * @param out the buffern in which to store the reference name
947 * @param remote the remote
948 * @return 0, GIT_ENOTFOUND if the remote does not have any references
949 * or none of them point to HEAD's commit, or an error message.
951 GIT_EXTERN(int) git_remote_default_branch(git_buf
*out
, git_remote
*remote
);