mirror of
https://github.com/git/git.git
synced 2024-05-04 20:36:15 +02:00
7915691377
It's usually a bad idea for a builtin's cmd_foo() to ignore the "prefix"
argument it gets, as it needs to prepend that string when accessing any
paths given by the user.
But if a builtin does not ask for the git wrapper to run repository
setup (via the RUN_SETUP or RUN_SETUP_GENTLY flags), then we know the
prefix will always be NULL (it is adjusting for the chdir() done during
repo setup, but there cannot be one if we did not set up the repo). In
those cases it's OK to ignore "prefix", but it's worth annotating for a
few reasons:
1. It serves as documentation to somebody reading the code about what
we expect.
2. If the flags in git.c ever change, the run-time assertion may help
detect the problem (though only if the command is run from a
subdirectory of the repository).
3. It notes to the compiler that we are OK ignoring "prefix". In
particular, this silences -Wunused-parameter. It _could_ also help
the compiler generate better code (because it will know the prefix
is NULL), but in practice this is quite unlikely to matter.
Note that I've only added this annotation to commands which triggered
-Wunused-parameter. It would be correct to add it to any builtin which
doesn't ask for RUN_SETUP, but most of the rest of them do the sensible
thing with "prefix" by passing it to parse_options(). So they're much
more likely to just work if they ever switched to RUN_SETUP, and aren't
worth annotating.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
99 lines
2.3 KiB
C
99 lines
2.3 KiB
C
/*
|
|
* GIT - The information manager from hell
|
|
*/
|
|
|
|
#include "cache.h"
|
|
#include "refs.h"
|
|
#include "builtin.h"
|
|
#include "strbuf.h"
|
|
|
|
static const char builtin_check_ref_format_usage[] =
|
|
"git check-ref-format [--normalize] [<options>] <refname>\n"
|
|
" or: git check-ref-format --branch <branchname-shorthand>";
|
|
|
|
/*
|
|
* Return a copy of refname but with leading slashes removed and runs
|
|
* of adjacent slashes replaced with single slashes.
|
|
*
|
|
* This function is similar to normalize_path_copy(), but stripped down
|
|
* to meet check_ref_format's simpler needs.
|
|
*/
|
|
static char *collapse_slashes(const char *refname)
|
|
{
|
|
char *ret = xmallocz(strlen(refname));
|
|
char ch;
|
|
char prev = '/';
|
|
char *cp = ret;
|
|
|
|
while ((ch = *refname++) != '\0') {
|
|
if (prev == '/' && ch == prev)
|
|
continue;
|
|
|
|
*cp++ = ch;
|
|
prev = ch;
|
|
}
|
|
*cp = '\0';
|
|
return ret;
|
|
}
|
|
|
|
static int check_ref_format_branch(const char *arg)
|
|
{
|
|
struct strbuf sb = STRBUF_INIT;
|
|
const char *name;
|
|
int nongit;
|
|
|
|
setup_git_directory_gently(&nongit);
|
|
if (strbuf_check_branch_ref(&sb, arg) ||
|
|
!skip_prefix(sb.buf, "refs/heads/", &name))
|
|
die("'%s' is not a valid branch name", arg);
|
|
printf("%s\n", name);
|
|
strbuf_release(&sb);
|
|
return 0;
|
|
}
|
|
|
|
int cmd_check_ref_format(int argc, const char **argv, const char *prefix)
|
|
{
|
|
int i;
|
|
int normalize = 0;
|
|
int flags = 0;
|
|
const char *refname;
|
|
char *to_free = NULL;
|
|
int ret = 1;
|
|
|
|
BUG_ON_NON_EMPTY_PREFIX(prefix);
|
|
|
|
if (argc == 2 && !strcmp(argv[1], "-h"))
|
|
usage(builtin_check_ref_format_usage);
|
|
|
|
if (argc == 3 && !strcmp(argv[1], "--branch"))
|
|
return check_ref_format_branch(argv[2]);
|
|
|
|
for (i = 1; i < argc && argv[i][0] == '-'; i++) {
|
|
if (!strcmp(argv[i], "--normalize") || !strcmp(argv[i], "--print"))
|
|
normalize = 1;
|
|
else if (!strcmp(argv[i], "--allow-onelevel"))
|
|
flags |= REFNAME_ALLOW_ONELEVEL;
|
|
else if (!strcmp(argv[i], "--no-allow-onelevel"))
|
|
flags &= ~REFNAME_ALLOW_ONELEVEL;
|
|
else if (!strcmp(argv[i], "--refspec-pattern"))
|
|
flags |= REFNAME_REFSPEC_PATTERN;
|
|
else
|
|
usage(builtin_check_ref_format_usage);
|
|
}
|
|
if (! (i == argc - 1))
|
|
usage(builtin_check_ref_format_usage);
|
|
|
|
refname = argv[i];
|
|
if (normalize)
|
|
refname = to_free = collapse_slashes(refname);
|
|
if (check_refname_format(refname, flags))
|
|
goto cleanup;
|
|
if (normalize)
|
|
printf("%s\n", refname);
|
|
|
|
ret = 0;
|
|
cleanup:
|
|
free(to_free);
|
|
return ret;
|
|
}
|