git中的分支描述

Question

git中有一種方法可以爲分支提供「描述」嗎？雖然我嘗試使用描述性名稱，但在單個分支上工作一段時間有時會減弱我爲什麼創建其他主題分支的記憶。我嘗試使用分支的描述性名稱，但我認爲'描述'（關於分支目的的簡短說明）會很好。

Answer 1

Git 1.7.9支持這個。從1.7.9 release notes：

 
* "git branch --edit-description" can be used to add descriptive text 
    to explain what a topic branch is about. 

你可以看到在2011年9月推出回到這個功能，以提交6f9a332，739453a3，b7200e8：

struct branch_desc_cb { 
    const char *config_name; 
    const char *value; 
}; 

--edit-description:: 

打開一個編輯器，編輯文本，以說明什麼分支用於被其他各種命令使用（例如request-pull）。

請注意，它不適用於分離的HEAD分支。

該描述被腳本request-pull使用：請參閱commit c016814783，還可以使用git merge --log。

request-pull是用來概括到標準輸出兩次提交之間的變化的腳本，並且包括在所生成的概要給定的URL。

Answer 2

我很確定該功能當前不受支持。我認爲你最好的選擇是在分支中創建一個描述文本文件，一個README文件，它有你想要的信息。

Answer 3

的README通過Chris J建議可以工作，只要它是建立一個custom merge driver defined in a .gitattribute。
這樣，本地版本的README始終保留在合併期間。

分支的「描述」也被稱爲與該元數據關聯的「註釋」，並且不被支持。

至少，有README文件，你可以爲任何一間分行，做：

$ git show myBranch:README 

如果你的自述是在你的REPO的根目錄下，它會從任何路徑工作，因爲由使用的路徑是來自所述回購的頂部目錄的絕對路徑。

Answer 4

選定的答案似乎對我來說過分殺傷。我傾向於維護每個分支描述文件，這是一個普通的源代碼控制文件，如master.txt,dev.txt等，如果有難以處理的數字或分支我會創建一個層次結構來更好地組織它。

Answer 5

您可以將意見標籤：

git tag -m 'this was a very good commit' tag1 

按照慣例，你可以有與您的分支名稱標籤或者你可以使用標籤-f保持註釋標記在您的主題分支的頭。

Answer 6

如果使用README做末起來，創建一個git alias修改git checkout，使您的README顯示每次轉換分支的時間。

例如，在〜/的.gitconfig添加此，下[別名]

cor = !sh -c 'git checkout $1 && cat README' - 

在此之後，可以運行git cor <branch_name>切換分支和顯示你是分支的自述切換到。

Answer 7

這裏是一個可能實現的git branches命令格雷格Hewgill提到的：

#!/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"; 
} 

Answer 8

使用git branch --edit-description設置或編輯一個分支描述。

這是一個shell函數，用於顯示類似於git branch的分支，但附有說明。

# Shows branches with descriptions 
function gb() { 
    branches=$(git for-each-ref --format='%(refname)' refs/heads/ | sed 's|refs/heads/||') 
    for branch in $branches; do 
    desc=$(git config branch.$branch.description) 
    if [ $branch == $(git rev-parse --abbrev-ref HEAD) ]; then 
     branch="* \033[0;32m$branch\033[0m" 
    else 
     branch=" $branch" 
    fi 
    echo -e "$branch \033[0;36m$desc\033[0m" 
    done 
} 

這裏是gb樣子，此處顯示爲的情況下，文本圖像腐爛：

$ gb 
* logging Log order details. Waiting for clarification from business. 
    master 
    sprocket Adding sprockets to the parts list. Pending QA approval. 

而作爲一個圖像，所以你可以看到的顏色：

Answer 9

使用：

git branch --list -v 

顯示上游分支：

git branch --list -vv 

添加-r只或-a顯示遙控器顯示遙控器和本地

Answer 10

有兩種流行的建議在這裏：

1. git branch --edit-description：我們不喜歡這個，因爲你不能推它。也許我可以記住我創建的分支是做什麼的，但我的團隊肯定不能。
2. README file pr。科。這是合併時的一種痛苦：超級傾向於合併衝突，當我們合併特徵分支時，我們將從分支中抽取README。樹枝之間的差異也是一種痛苦。

我們決定創建一個孤兒branches-readme分支。孤兒分支機構是擁有自己獨立歷史的分支機構 - 您可以從Github的gh-pages分支機構瞭解它們。這個孤兒分支包含一個單獨的README文件。它有像這樣的內容：

master: 
    The default branch 
mojolicious: 
    Start using Mojolicious 
branch-whatever: 
    Description of the whatever branch 

這是推和合並友好。從任何一間分行查看README有：

git show branches-readme:README 

缺點是，你需要簽出怪異的孤兒分支，當你想更新README和README不作爲分支機構獲得改名不自動更新，來或去。不過，這對我們來說很好。

不喜歡它：

git checkout --orphan branches-readme 
# All the files from the old branch are marked for addition - skip that 
git reset --hard 
# There are no files yet - an empty branch 
ls 
vi README 
# put in contents similar to above 
git add README 
git commit -m "Initial description of the branches we already have" 
git push origin branches-readme 
# get all your original files back 
git checkout master 

與之相似，各個團隊成員也可以創建自己的branches-$user孤兒分支機構描述自己的私有分支，如果他們想，只要他們沒有他們推到球隊。

隨着進一步的工具，這也可以與git branch的輸出集成。爲此，或許可以考慮README.yaml文件而不是簡單的README。

Answer 11

git config --global --add alias.about '!describe() { git config branch."$1".description; }; describe' 

命令將定義一個全局選項alias.about作爲shell表達式。在存儲庫中運行git about <branch>將顯示分支的說明（如果設置）。

Answer 12

只需使用：

git config branch.<branch name>.description 

要給予信貸，信貸是由於： https://glebbahmutov.com/blog/git-branches-with-descriptions/