mirror of
https://github.com/git/git.git
synced 2026-03-01 18:24:00 +01:00
ac1f12a9de
Git alias names are limited to ASCII alphanumeric characters and
dashes because aliases are implemented as config variable names.
This prevents aliases being created in languages using characters outside that range.
Add support for arbitrary alias names by using config subsections:
[alias "förgrena"]
command = branch
The subsection name is matched as-is (case-sensitive byte comparison),
while the existing definition without a subsection (e.g.,
"[alias] co = checkout") remains case-insensitive for backward
compatibility. This uses existing config infrastructure since
subsections already support arbitrary bytes, and avoids introducing
Unicode normalization.
Also teach the help subsystem about the new syntax so that "git help
-a" properly lists subsection aliases and the autocorrect feature can
suggest them. Use utf8_strwidth() instead of strlen() for column
alignment so that non-ASCII alias names display correctly.
Suggested-by: Jeff King <peff@peff.net>
Signed-off-by: Jonatan Holmgren <jonatan@jontes.page>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
79 lines
3.3 KiB
Plaintext
79 lines
3.3 KiB
Plaintext
alias.*::
|
|
alias.*.command::
|
|
Command aliases for the linkgit:git[1] command wrapper. Aliases
|
|
can be defined using two syntaxes:
|
|
+
|
|
--
|
|
1. Without a subsection, e.g., `[alias] co = checkout`. The alias
|
|
name ("co" in this example) is
|
|
limited to ASCII alphanumeric characters and `-`,
|
|
and is matched case-insensitively.
|
|
2. With a subsection, e.g., `[alias "co"] command = checkout`. The
|
|
alias name can contain any characters (except for newlines and NUL bytes),
|
|
including UTF-8, and is matched case-sensitively as raw bytes.
|
|
You define the action of the alias in the `command`.
|
|
--
|
|
+
|
|
Examples:
|
|
+
|
|
----
|
|
# Without subsection (ASCII alphanumeric and dash only)
|
|
[alias]
|
|
co = checkout
|
|
st = status
|
|
|
|
# With subsection (allows any characters, including UTF-8)
|
|
[alias "hämta"]
|
|
command = fetch
|
|
[alias "rätta till"]
|
|
command = commit --amend
|
|
----
|
|
+
|
|
With a Git alias defined, e.g.,
|
|
|
|
$ git config --global alias.last "cat-file commit HEAD"
|
|
# Which is equivalent to
|
|
$ git config --global alias.last.command "cat-file commit HEAD"
|
|
|
|
`git last` is equivalent to `git cat-file commit HEAD`. To avoid
|
|
confusion and troubles with script usage, aliases that
|
|
hide existing Git commands are ignored except for deprecated
|
|
commands. Arguments are split by
|
|
spaces, the usual shell quoting and escaping are supported.
|
|
A quote pair or a backslash can be used to quote them.
|
|
+
|
|
Note that the first word of an alias does not necessarily have to be a
|
|
command. It can be a command-line option that will be passed into the
|
|
invocation of `git`. In particular, this is useful when used with `-c`
|
|
to pass in one-time configurations or `-p` to force pagination. For example,
|
|
`loud-rebase = -c commit.verbose=true rebase` can be defined such that
|
|
running `git loud-rebase` would be equivalent to
|
|
`git -c commit.verbose=true rebase`. Also, `ps = -p status` would be a
|
|
helpful alias since `git ps` would paginate the output of `git status`
|
|
where the original command does not.
|
|
+
|
|
If the alias expansion is prefixed with an exclamation point,
|
|
it will be treated as a shell command. For example, defining
|
|
`alias.new = !gitk --all --not ORIG_HEAD`, the invocation
|
|
`git new` is equivalent to running the shell command
|
|
`gitk --all --not ORIG_HEAD`. Note:
|
|
+
|
|
* Shell commands will be executed from the top-level directory of a
|
|
repository, which may not necessarily be the current directory.
|
|
* `GIT_PREFIX` is set as returned by running `git rev-parse --show-prefix`
|
|
from the original current directory. See linkgit:git-rev-parse[1].
|
|
* Shell command aliases always receive any extra arguments provided to
|
|
the Git command-line as positional arguments.
|
|
** Care should be taken if your shell alias is a "one-liner" script
|
|
with multiple commands (e.g. in a pipeline), references multiple
|
|
arguments, or is otherwise not able to handle positional arguments
|
|
added at the end. For example: `alias.cmd = "!echo $1 | grep $2"`
|
|
called as `git cmd 1 2` will be executed as 'echo $1 | grep $2
|
|
1 2', which is not what you want.
|
|
** A convenient way to deal with this is to write your script
|
|
operations in an inline function that is then called with any
|
|
arguments from the command-line. For example `alias.cmd = "!c() {
|
|
echo $1 | grep $2 ; }; c"` will correctly execute the prior example.
|
|
** Setting `GIT_TRACE=1` can help you debug the command being run for
|
|
your alias.
|