what should be in the git description file?

After initialising a new local repo there is a description file present.

What is it used for and how should I format it? Or is it simply a local helper file.

  • How can I commit many new files with git gui without clicking each of it?
  • Jenkins Poll SCM (Git) on Windows master / Build on Linux slave
  • Git asks for password for each commit and pull
  • List of all git commits?
  • Pull to Hg repo from Git repo that is the same project but has lost the history
  • Trying to install GIT on CentOS 5 and a little lost
  • This thread Accessing git‘s `description’ file suggests one style, but no man page or other reference to why it should be the way it is.

  • Got an import error all of a sudden
  • Using Git to version Microsoft Dynamics NAV?
  • How to I add something to the .gitignore so that the match is not recursive?
  • Is there a way to reuse the previous comment on a git commit?
  • New pull request without unmerged commits
  • Eclipse shortcut for Compare With Head Revision
  • 3 Solutions collect form web for “what should be in the git description file?”

    description file is only used by the GitWeb program ( to display the description of the repo on the GitWeb page)


    Otherwise, how you use it is left to you and I don’t see a point in a “style” for it.

    The description file can also be read by hook scripts or other scripts pertaining to the repository. For example, one popular hook script, post-receive-email, sends an email to all members when a commit is made to the repository, and uses the contents of the description file as the name of the repository in the email subject.

    description is just a text file that is shown as project description in web frontend.

    Just write there something that explains what the repository is about.

    Git Baby is a git and github fan, let's start git clone.