Git branch description

Question

I set just a simple description for my local branch and now I'd like to see it. How one can see description for a branch set by issuing git branch --edit-description?

Does this answer your question? [Print branch description](https://stackoverflow.com/questions/15058844/print-branch-description) — imz -- Ivan Zakharyaschev, Jul 28 '21 at 13:39
You can use the command form this answer as well https://stackoverflow.com/questions/18516895/how-to-view-branch-descriptions-without-editing-them — rkachach, Mar 30 '22 at 15:00

score 2 · Accepted Answer · answered Mar 24 '14 at 10:32

2

The description is used for request-pull (as stated in the man-page). This has already been discussed here.

answered Mar 24 '14 at 10:32

mattmilten

6,242
3
35
65

Thank you! But, is there any way to attach description to a branch that can be seen later? I'm talking about something simple like issuing `git branch` or `git notes` with certain flags and get description set previously... – mesmerizingr Mar 24 '14 at 11:27
I don't know of any simple way to display the branch description, unfortunately. You may parse `.git/BRANCH_DESCRIPTION`, of course, but I don't know whether this information is published to other repos with `push` or `pull`. – mattmilten Mar 24 '14 at 13:28

score 0 · Answer 2 · answered Feb 15 '22 at 13:20

It is possible to show the branch descriptions by interrogating the repos config settings, which is where the description is stored.

I have two aliases defined, one shows all branches that have descriptions, and the second shows the description of the current HEAD branch

    brshow = config --get-regexp 'branch.*.description'
    brshow1 = !git config --get "branch.$(git rev-parse --abbrev-ref HEAD).description"

Git branch description

2 Answers2