Git中是否有一种为分支提供“描述”的方法?
虽然我尝试使用描述性的名称,但在一个分支上工作一段时间,有时会使我对为什么要创建其他一些主题分支的记忆变得模糊。我尝试为分支使用描述性的名称,但我认为“描述”(关于分支目的的简短说明)会很好。
Git中是否有一种为分支提供“描述”的方法?
虽然我尝试使用描述性的名称,但在一个分支上工作一段时间,有时会使我对为什么要创建其他一些主题分支的记忆变得模糊。我尝试为分支使用描述性的名称,但我认为“描述”(关于分支目的的简短说明)会很好。
当前回答
选定的答案对我来说似乎太夸张了。我倾向于维护每个分支的描述文件,这是一个正常的源代码控制文件,比如master.txt, dev.txt等,如果有一个难以处理的数字或分支,我会创建一个层次结构来更好地组织它。
其他回答
下面是Greg Hewgill提到的git分支命令的一个可能实现:
#!/usr/bin/perl
sub clean {
map { s/^[\s\*]*\s// } @_;
map { s/\s*$// } @_;
return @_;
}
sub descr {
$_ = `git config branch.@_.description`;
s/\s*$//;
return $_;
};
sub indent {
$_ = shift;
s/^/ /mg;
return $_;
};
my @branches = clean `git branch --color=never --list`;
my %merged = map { $_ => 1 } clean `git branch --color=never --merged`;
for my $branch (@branches) {
my $asis = `git branch --list --color=always $branch`;
$asis =~ s/\s*$//;
print " $asis";
print " \033[33m(merged)\033[0m" if ($merged{$branch} and $branch ne "master");
print "\n";
print indent descr $branch;
print "\n";
print "\n";
}
Use
git branch --list -v
显示上游分支:
git branch --list -vv
添加-r只显示远程或-a显示远程和本地。
如果您最终要使用README,请创建一个git别名,修改git checkout,以便在每次切换分支时显示您的README。
例如,在~/中添加这个。Gitconfig,在[alias]下
cor = !sh -c 'git checkout $1 && cat README' -
在此之后,您可以运行git cor <branch_name>来切换分支,并显示您要切换到的分支的README。
Git 1.7.9支持这一点。从1.7.9版本说明中可以看到:
* "git branch --edit-description" can be used to add descriptive text to explain what a topic branch is about.
你可以在提交6f9a332、739453a3、b7200e8时看到该特性早在2011年9月就已经引入:
struct branch_desc_cb {
const char *config_name;
const char *value;
};
--edit-description::
打开编辑器并编辑文本以解释分支的用途,以供各种其他命令使用(例如请求-拉取)。
注意,它不适用于分离的HEAD分支。
这个描述被脚本request-pull使用:参见commit c016814783,还有git merge——log。
request-pull是一个脚本,用于总结两次提交到标准输出之间的更改,并在生成的摘要中包含给定的URL。
不幸的是,你不能推送描述,因为它们存储在你的配置中,这对于团队中的分支来说是无用的。
下面是一个git别名,它可以让你设置和读取当前分支的描述:
git config --global --add alias.about '!describe() { msg="$1"; git config branch."$(git rev-parse --abbrev-ref HEAD)".description ${msg:+"$msg"}; }; describe'
使用/例子:
(develop) $ git about
(develop) $ git about message
(develop) $ git about
message
(develop) $ git about "this is a new message"
(develop) $ git about
this is a new message
(develop) $ git checkout -b test_branch
Switched to a new branch 'test_branch'
(test_branch) $ git about
(test_branch) $ git about "this is the test branch"
(test_branch) $ git about
this is the test branch
(test_branch) $ git checkout -
Switched to branch 'develop'
Your branch is up to date with 'origin/develop'.
(develop) $ git about
this is a new message
特别感谢@Felicio的回答,让我开始了。