Files
git/promisor-remote.h
Christian Couder e15a6b2f8b promisor-remote: change promisor_remote_reply()'s signature
The `promisor_remote_reply()` function performs two tasks:
1. It uses filter_promisor_remote() to parse the server's
   "promisor-remote" advertisement and to mark accepted remotes in the
   repository configuration.
2. It assembles a reply string containing the accepted remote names to
   send back to the server.

In a following commit, the fetch-pack logic will need to trigger the
side effect (1) to ensure the repository state is correct, but it will
not need to send a reply (2).

To avoid assembling a reply string when it is not needed, let's change
the signature of promisor_remote_reply(). It will now return `void` and
accept a second `char **accepted_out` argument. Only if that argument
is not NULL will a reply string be assembled and returned back to the
caller via that argument.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2026-02-17 11:46:41 -08:00

78 lines
2.5 KiB
C

#ifndef PROMISOR_REMOTE_H
#define PROMISOR_REMOTE_H
#include "repository.h"
struct object_id;
/*
* Promisor remote linked list
*
* Information in its fields come from remote.XXX config entries or
* from extensions.partialclone, except for 'accepted' which comes
* from protocol v2 capabilities exchange.
*/
struct promisor_remote {
struct promisor_remote *next;
char *partial_clone_filter;
char *advertised_filter;
unsigned int accepted : 1;
const char name[FLEX_ARRAY];
};
void repo_promisor_remote_reinit(struct repository *r);
void promisor_remote_clear(struct promisor_remote_config *config);
struct promisor_remote *repo_promisor_remote_find(struct repository *r, const char *remote_name);
int repo_has_promisor_remote(struct repository *r);
/*
* Fetches all requested objects from all promisor remotes, trying them one at
* a time until all objects are fetched.
*
* If oid_nr is 0, this function returns immediately.
*/
void promisor_remote_get_direct(struct repository *repo,
const struct object_id *oids,
int oid_nr);
/*
* Prepare a "promisor-remote" advertisement by a server.
* Check the value of "promisor.advertise" and maybe the configured
* promisor remotes, if any, to prepare information to send in an
* advertisement.
* Return value is NULL if no promisor remote advertisement should be
* made. Otherwise it contains the names and urls of the advertised
* promisor remotes separated by ';'. See gitprotocol-v2(5).
*/
char *promisor_remote_info(struct repository *repo);
/*
* Prepare a reply to a "promisor-remote" advertisement from a server.
* Check the value of "promisor.acceptfromserver" and maybe the
* configured promisor remotes, if any, to prepare the reply. If the
* `accepted_out` argument is not NULL, it is set to either NULL or to
* the names of the accepted promisor remotes separated by ';' if
* any. See gitprotocol-v2(5).
*/
void promisor_remote_reply(const char *info, char **accepted_out);
/*
* Set the 'accepted' flag for some promisor remotes. Useful on the
* server side when some promisor remotes have been accepted by the
* client.
*/
void mark_promisor_remotes_as_accepted(struct repository *repo, const char *remotes);
/*
* Has any promisor remote been accepted by the client?
*/
int repo_has_accepted_promisor_remote(struct repository *r);
/*
* Use the filters from the accepted remotes to create a combined
* filter (useful in `--filter=auto` mode).
*/
char *promisor_remote_construct_filter(struct repository *repo);
#endif /* PROMISOR_REMOTE_H */