2006-04-21 17:27:34 +00:00
|
|
|
/*
|
|
|
|
* builtin-help.c
|
|
|
|
*
|
|
|
|
* Builtin help-related commands (help, usage, version)
|
|
|
|
*/
|
|
|
|
#include "cache.h"
|
|
|
|
#include "builtin.h"
|
|
|
|
#include "exec_cmd.h"
|
|
|
|
#include "common-cmds.h"
|
2006-12-19 22:34:12 +00:00
|
|
|
#include <sys/ioctl.h>
|
2006-04-21 17:27:34 +00:00
|
|
|
|
2006-07-10 05:50:18 +00:00
|
|
|
/* most GUI terminals set COLUMNS (although some don't export it) */
|
2006-04-21 17:27:34 +00:00
|
|
|
static int term_columns(void)
|
|
|
|
{
|
|
|
|
char *col_string = getenv("COLUMNS");
|
2006-08-15 17:23:48 +00:00
|
|
|
int n_cols;
|
2006-04-21 17:27:34 +00:00
|
|
|
|
|
|
|
if (col_string && (n_cols = atoi(col_string)) > 0)
|
|
|
|
return n_cols;
|
|
|
|
|
|
|
|
#ifdef TIOCGWINSZ
|
|
|
|
{
|
|
|
|
struct winsize ws;
|
|
|
|
if (!ioctl(1, TIOCGWINSZ, &ws)) {
|
|
|
|
if (ws.ws_col)
|
|
|
|
return ws.ws_col;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
return 80;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void mput_char(char c, unsigned int num)
|
|
|
|
{
|
|
|
|
while(num--)
|
|
|
|
putchar(c);
|
|
|
|
}
|
|
|
|
|
2007-10-29 03:30:52 +00:00
|
|
|
static struct cmdnames {
|
|
|
|
int alloc;
|
|
|
|
int cnt;
|
|
|
|
struct cmdname {
|
|
|
|
size_t len;
|
|
|
|
char name[1];
|
|
|
|
} **names;
|
|
|
|
} main_cmds, other_cmds;
|
|
|
|
|
|
|
|
static void add_cmdname(struct cmdnames *cmds, const char *name, int len)
|
2006-04-21 17:27:34 +00:00
|
|
|
{
|
2007-10-29 03:30:52 +00:00
|
|
|
struct cmdname *ent = xmalloc(sizeof(*ent) + len);
|
|
|
|
|
2006-04-21 17:27:34 +00:00
|
|
|
ent->len = len;
|
|
|
|
memcpy(ent->name, name, len);
|
|
|
|
ent->name[len] = 0;
|
2007-10-29 03:30:52 +00:00
|
|
|
|
|
|
|
ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
|
|
|
|
cmds->names[cmds->cnt++] = ent;
|
2006-04-21 17:27:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static int cmdname_compare(const void *a_, const void *b_)
|
|
|
|
{
|
|
|
|
struct cmdname *a = *(struct cmdname **)a_;
|
|
|
|
struct cmdname *b = *(struct cmdname **)b_;
|
|
|
|
return strcmp(a->name, b->name);
|
|
|
|
}
|
|
|
|
|
2007-10-29 03:30:52 +00:00
|
|
|
static void uniq(struct cmdnames *cmds)
|
|
|
|
{
|
|
|
|
int i, j;
|
|
|
|
|
|
|
|
if (!cmds->cnt)
|
|
|
|
return;
|
|
|
|
|
|
|
|
for (i = j = 1; i < cmds->cnt; i++)
|
|
|
|
if (strcmp(cmds->names[i]->name, cmds->names[i-1]->name))
|
|
|
|
cmds->names[j++] = cmds->names[i];
|
|
|
|
|
|
|
|
cmds->cnt = j;
|
|
|
|
}
|
|
|
|
|
|
|
|
static void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes) {
|
|
|
|
int ci, cj, ei;
|
|
|
|
int cmp;
|
|
|
|
|
|
|
|
ci = cj = ei = 0;
|
|
|
|
while (ci < cmds->cnt && ei < excludes->cnt) {
|
|
|
|
cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
|
|
|
|
if (cmp < 0)
|
|
|
|
cmds->names[cj++] = cmds->names[ci++];
|
|
|
|
else if (cmp == 0)
|
|
|
|
ci++, ei++;
|
|
|
|
else if (cmp > 0)
|
|
|
|
ei++;
|
|
|
|
}
|
|
|
|
|
|
|
|
while (ci < cmds->cnt)
|
|
|
|
cmds->names[cj++] = cmds->names[ci++];
|
|
|
|
|
|
|
|
cmds->cnt = cj;
|
|
|
|
}
|
|
|
|
|
|
|
|
static void pretty_print_string_list(struct cmdnames *cmds, int longest)
|
2006-04-21 17:27:34 +00:00
|
|
|
{
|
|
|
|
int cols = 1, rows;
|
|
|
|
int space = longest + 1; /* min 1 SP between words */
|
|
|
|
int max_cols = term_columns() - 1; /* don't print *on* the edge */
|
|
|
|
int i, j;
|
|
|
|
|
|
|
|
if (space < max_cols)
|
|
|
|
cols = max_cols / space;
|
2007-10-29 03:30:52 +00:00
|
|
|
rows = (cmds->cnt + cols - 1) / cols;
|
2006-04-21 17:27:34 +00:00
|
|
|
|
|
|
|
for (i = 0; i < rows; i++) {
|
|
|
|
printf(" ");
|
|
|
|
|
|
|
|
for (j = 0; j < cols; j++) {
|
|
|
|
int n = j * rows + i;
|
|
|
|
int size = space;
|
2007-10-29 03:30:52 +00:00
|
|
|
if (n >= cmds->cnt)
|
2006-04-21 17:27:34 +00:00
|
|
|
break;
|
2007-10-29 03:30:52 +00:00
|
|
|
if (j == cols-1 || n + rows >= cmds->cnt)
|
2006-04-21 17:27:34 +00:00
|
|
|
size = 1;
|
2007-10-29 03:30:52 +00:00
|
|
|
printf("%-*s", size, cmds->names[n]->name);
|
2006-04-21 17:27:34 +00:00
|
|
|
}
|
|
|
|
putchar('\n');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2007-10-29 03:30:52 +00:00
|
|
|
static unsigned int list_commands_in_dir(struct cmdnames *cmds,
|
|
|
|
const char *path)
|
2006-04-21 17:27:34 +00:00
|
|
|
{
|
|
|
|
unsigned int longest = 0;
|
2007-10-27 08:36:50 +00:00
|
|
|
const char *prefix = "git-";
|
|
|
|
int prefix_len = strlen(prefix);
|
2007-10-29 03:30:52 +00:00
|
|
|
DIR *dir = opendir(path);
|
2006-04-21 17:27:34 +00:00
|
|
|
struct dirent *de;
|
|
|
|
|
2007-10-29 03:30:52 +00:00
|
|
|
if (!dir || chdir(path))
|
|
|
|
return 0;
|
2006-04-21 17:27:34 +00:00
|
|
|
|
|
|
|
while ((de = readdir(dir)) != NULL) {
|
|
|
|
struct stat st;
|
|
|
|
int entlen;
|
|
|
|
|
2007-10-27 08:36:50 +00:00
|
|
|
if (prefixcmp(de->d_name, prefix))
|
2006-04-21 17:27:34 +00:00
|
|
|
continue;
|
2007-10-27 08:36:52 +00:00
|
|
|
|
|
|
|
if (stat(de->d_name, &st) || /* stat, not lstat */
|
2006-04-21 17:27:34 +00:00
|
|
|
!S_ISREG(st.st_mode) ||
|
|
|
|
!(st.st_mode & S_IXUSR))
|
|
|
|
continue;
|
|
|
|
|
2007-10-27 08:36:50 +00:00
|
|
|
entlen = strlen(de->d_name) - prefix_len;
|
2006-08-11 12:01:45 +00:00
|
|
|
if (has_extension(de->d_name, ".exe"))
|
2006-04-21 17:27:34 +00:00
|
|
|
entlen -= 4;
|
|
|
|
|
|
|
|
if (longest < entlen)
|
|
|
|
longest = entlen;
|
|
|
|
|
2007-10-29 03:30:52 +00:00
|
|
|
add_cmdname(cmds, de->d_name + prefix_len, entlen);
|
2006-04-21 17:27:34 +00:00
|
|
|
}
|
|
|
|
closedir(dir);
|
|
|
|
|
2007-10-29 03:30:52 +00:00
|
|
|
return longest;
|
|
|
|
}
|
|
|
|
|
|
|
|
static void list_commands(void)
|
|
|
|
{
|
|
|
|
unsigned int longest = 0;
|
|
|
|
unsigned int len;
|
|
|
|
const char *env_path = getenv("PATH");
|
|
|
|
char *paths, *path, *colon;
|
|
|
|
const char *exec_path = git_exec_path();
|
|
|
|
|
|
|
|
if (exec_path)
|
|
|
|
longest = list_commands_in_dir(&main_cmds, exec_path);
|
|
|
|
|
|
|
|
if (!env_path) {
|
|
|
|
fprintf(stderr, "PATH not set\n");
|
|
|
|
exit(1);
|
|
|
|
}
|
|
|
|
|
|
|
|
path = paths = xstrdup(env_path);
|
|
|
|
while (1) {
|
|
|
|
if ((colon = strchr(path, ':')))
|
|
|
|
*colon = 0;
|
|
|
|
|
|
|
|
len = list_commands_in_dir(&other_cmds, path);
|
|
|
|
if (len > longest)
|
|
|
|
longest = len;
|
|
|
|
|
|
|
|
if (!colon)
|
|
|
|
break;
|
|
|
|
path = colon + 1;
|
|
|
|
}
|
|
|
|
free(paths);
|
|
|
|
|
|
|
|
qsort(main_cmds.names, main_cmds.cnt,
|
|
|
|
sizeof(*main_cmds.names), cmdname_compare);
|
|
|
|
uniq(&main_cmds);
|
|
|
|
|
|
|
|
qsort(other_cmds.names, other_cmds.cnt,
|
|
|
|
sizeof(*other_cmds.names), cmdname_compare);
|
|
|
|
uniq(&other_cmds);
|
|
|
|
exclude_cmds(&other_cmds, &main_cmds);
|
|
|
|
|
|
|
|
if (main_cmds.cnt) {
|
|
|
|
printf("available git commands in '%s'\n", exec_path);
|
|
|
|
printf("----------------------------");
|
|
|
|
mput_char('-', strlen(exec_path));
|
|
|
|
putchar('\n');
|
|
|
|
pretty_print_string_list(&main_cmds, longest);
|
|
|
|
putchar('\n');
|
|
|
|
}
|
|
|
|
|
|
|
|
if (other_cmds.cnt) {
|
|
|
|
printf("git commands available from elsewhere on your $PATH\n");
|
|
|
|
printf("---------------------------------------------------\n");
|
|
|
|
pretty_print_string_list(&other_cmds, longest);
|
|
|
|
putchar('\n');
|
|
|
|
}
|
2006-04-21 17:27:34 +00:00
|
|
|
}
|
|
|
|
|
2007-10-27 08:36:49 +00:00
|
|
|
void list_common_cmds_help(void)
|
2006-04-21 17:27:34 +00:00
|
|
|
{
|
|
|
|
int i, longest = 0;
|
|
|
|
|
|
|
|
for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
|
|
|
|
if (longest < strlen(common_cmds[i].name))
|
|
|
|
longest = strlen(common_cmds[i].name);
|
|
|
|
}
|
|
|
|
|
|
|
|
puts("The most commonly used git commands are:");
|
|
|
|
for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
|
2007-02-11 13:29:58 +00:00
|
|
|
printf(" %s ", common_cmds[i].name);
|
|
|
|
mput_char(' ', longest - strlen(common_cmds[i].name));
|
2006-04-21 17:27:34 +00:00
|
|
|
puts(common_cmds[i].help);
|
|
|
|
}
|
|
|
|
puts("(use 'git help -a' to get a list of all installed git commands)");
|
|
|
|
}
|
|
|
|
|
|
|
|
static void show_man_page(const char *git_cmd)
|
|
|
|
{
|
|
|
|
const char *page;
|
|
|
|
|
Mechanical conversion to use prefixcmp()
This mechanically converts strncmp() to use prefixcmp(), but only when
the parameters match specific patterns, so that they can be verified
easily. Leftover from this will be fixed in a separate step, including
idiotic conversions like
if (!strncmp("foo", arg, 3))
=>
if (!(-prefixcmp(arg, "foo")))
This was done by using this script in px.perl
#!/usr/bin/perl -i.bak -p
if (/strncmp\(([^,]+), "([^\\"]*)", (\d+)\)/ && (length($2) == $3)) {
s|strncmp\(([^,]+), "([^\\"]*)", (\d+)\)|prefixcmp($1, "$2")|;
}
if (/strncmp\("([^\\"]*)", ([^,]+), (\d+)\)/ && (length($1) == $3)) {
s|strncmp\("([^\\"]*)", ([^,]+), (\d+)\)|(-prefixcmp($2, "$1"))|;
}
and running:
$ git grep -l strncmp -- '*.c' | xargs perl px.perl
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-20 09:53:29 +00:00
|
|
|
if (!prefixcmp(git_cmd, "git"))
|
2006-04-21 17:27:34 +00:00
|
|
|
page = git_cmd;
|
|
|
|
else {
|
|
|
|
int page_len = strlen(git_cmd) + 4;
|
2006-08-31 22:32:39 +00:00
|
|
|
char *p = xmalloc(page_len + 1);
|
2006-04-21 17:27:34 +00:00
|
|
|
strcpy(p, "git-");
|
|
|
|
strcpy(p + 4, git_cmd);
|
|
|
|
p[page_len] = 0;
|
|
|
|
page = p;
|
|
|
|
}
|
|
|
|
|
|
|
|
execlp("man", "man", page, NULL);
|
|
|
|
}
|
|
|
|
|
2006-07-30 21:42:25 +00:00
|
|
|
void help_unknown_cmd(const char *cmd)
|
|
|
|
{
|
2007-10-27 06:26:41 +00:00
|
|
|
fprintf(stderr, "git: '%s' is not a git-command. See 'git --help'.\n", cmd);
|
2006-07-30 21:42:25 +00:00
|
|
|
exit(1);
|
|
|
|
}
|
|
|
|
|
2006-07-29 05:44:25 +00:00
|
|
|
int cmd_version(int argc, const char **argv, const char *prefix)
|
2006-04-21 17:27:34 +00:00
|
|
|
{
|
|
|
|
printf("git version %s\n", git_version_string);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2006-07-29 05:44:25 +00:00
|
|
|
int cmd_help(int argc, const char **argv, const char *prefix)
|
2006-04-21 17:27:34 +00:00
|
|
|
{
|
2006-07-25 18:24:22 +00:00
|
|
|
const char *help_cmd = argc > 1 ? argv[1] : NULL;
|
2006-07-30 21:42:25 +00:00
|
|
|
|
|
|
|
if (!help_cmd) {
|
|
|
|
printf("usage: %s\n\n", git_usage_string);
|
|
|
|
list_common_cmds_help();
|
2007-10-27 08:36:49 +00:00
|
|
|
exit(0);
|
2006-07-30 21:42:25 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
else if (!strcmp(help_cmd, "--all") || !strcmp(help_cmd, "-a")) {
|
|
|
|
printf("usage: %s\n\n", git_usage_string);
|
2007-10-29 03:30:52 +00:00
|
|
|
list_commands();
|
2007-10-27 08:36:49 +00:00
|
|
|
exit(0);
|
2006-07-30 21:42:25 +00:00
|
|
|
}
|
|
|
|
|
2006-04-21 17:27:34 +00:00
|
|
|
else
|
|
|
|
show_man_page(help_cmd);
|
2006-07-30 21:42:25 +00:00
|
|
|
|
2006-04-21 17:27:34 +00:00
|
|
|
return 0;
|
|
|
|
}
|