git/checkout.h

#ifndef CHECKOUT_H
#define CHECKOUT_H

#include "hash-ll.h"

/*
 * Check if the branch name uniquely matches a branch name on a remote
 * tracking branch.  Return the name of the remote if such a branch
 * exists, NULL otherwise.
 */
char *unique_tracking_name(const char *name,
			   struct object_id *oid,
			   int *dwim_remotes_matched);

#endif /* CHECKOUT_H */
checkout: factor out functions to new lib file Factor the functions out, so they can be re-used from other places. In particular these functions will be re-used in builtin/worktree.c to make git worktree add dwim more. While there add some docs to the function. Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2017-11-26 19:43:51 +00:00			`#ifndef CHECKOUT_H`
			`#define CHECKOUT_H`

hash-ll.h: split out of hash.h to remove dependency on repository.h hash.h depends upon and includes repository.h, due to the definition and use of the_hash_algo (defined as the_repository->hash_algo). However, most headers trying to include hash.h are only interested in the layout of the structs like object_id. Move the parts of hash.h that do not depend upon repository.h into a new file hash-ll.h (the "low level" parts of hash.h), and adjust other files to use this new header where the convenience inline functions aren't needed. This allows hash.h and object.h to be fairly small, minimal headers. It also exposes a lot of hidden dependencies on both path.h (which was brought in by repository.h) and repository.h (which was previously implicitly brought in by object.h), so also adjust other files to be more explicit about what they depend upon. Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2023-04-22 20:17:20 +00:00			`#include "hash-ll.h"`
checkout: factor out functions to new lib file Factor the functions out, so they can be re-used from other places. In particular these functions will be re-used in builtin/worktree.c to make git worktree add dwim more. While there add some docs to the function. Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2017-11-26 19:43:51 +00:00
			`/*`
			`* Check if the branch name uniquely matches a branch name on a remote`
			`* tracking branch. Return the name of the remote if such a branch`
			`* exists, NULL otherwise.`
			`*/`
checkout: clarify memory ownership in `unique_tracking_name()` The function `unique_tracking_name()` returns an allocated string, but does not clearly indicate this because its return type is `const char ` instead of `char `. This has led to various callsites where we never free its returned memory at all, which causes memory leaks. Plug those leaks and mark now-passing tests as leak free. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2024-05-27 11:46:06 +00:00			`char unique_tracking_name(const char name,`
			`struct object_id *oid,`
			`int *dwim_remotes_matched);`
checkout: factor out functions to new lib file Factor the functions out, so they can be re-used from other places. In particular these functions will be re-used in builtin/worktree.c to make git worktree add dwim more. While there add some docs to the function. Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2017-11-26 19:43:51 +00:00
			`#endif /* CHECKOUT_H */`