Re: Including the release notes in the git-1.5.0 release?

From: Junio C Hamano <junkio@cox.net>
Date: Feb 13, 2007, 17:44 UTC
Message-ID: <7vzm7ix895.fsf@assigned-by-dhcp.cox.net>
In-Reply-To: <E1HGyPn-0003Te-9s@candygram.thunk.org>

"Theodore Ts'o" <tytso@mit.edu> writes:

Show 10 quoted lines

> As a suggestion, maybe it would be a good idea to actually include it as
> RELEASE-NOTES in the top-level source tree of git.   This will make it
> much more likely that people packaging git will include in
> /usr/share/doc/git.  
>
> Or better yet, maybe we should include it in the Documentation directory
> and set it up to be built as a manpage, git-release-notes.  This will
> make it much more likely that end users who are getting git from their
> Fedora, Debian, Red Hat, et. al distribution will actually see the
> release notes when they install the new package.

Indeed I was planning to use it as the announcement message, but including it in the final tarball sounds sensible.

As the text assumes familiarity with git 1.3.0 or so, I am not sure if making it as one of the manpages makes much sense.

Also there is a question of what to do when 1.6.0 comes out. Will its release notes replace 1.5.0 one? If so changes from which version will it describe?

I suspect that doing something like:

	git cat-file todo:v1.5.0.txt >Documentation/v1.5.0.txt
	ln -s Documentation/v1.5.0.txt RELEASE-NOTES
        git add RELEASE-NOTES Documentation/v1.5.0.txt

and have pointer to v1.5.0.txt from Documentation/git.txt would be a sensible and easy thing to do.