{"thread":{"id":"6797","subject":"Including the release notes in the git-1.5.0 release?","startedAt":"2007-02-13T14:13:51Z","lastAt":"2007-02-14T16:27:41Z","messageCount":4,"participants":["Theodore Ts'o","Junio C Hamano","Theodore Tso"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"34404","messageId":"E1HGyPn-0003Te-9s@candygram.thunk.org","threadId":"6797","inReplyTo":null,"subject":"Including the release notes in the git-1.5.0 release?","fromName":"Theodore Ts'o","fromEmail":"tytso@mit.edu","sentAt":"2007-02-13T14:13:51Z","receivedAt":"2007-02-13T14:13:51Z","isPatch":false,"sender":{"key":"tytso@mit.edu","avatar":"https://avatars.githubusercontent.com/u/51416?v=4"},"body":"Junio,\n\nI noticed that the file v1.5.0.txt is still in the todo branch, but not\nin the actual main git branch. I assume that this means you were\nplanning on including the v1.5.0.txt in the git announcement, but not\nnecessarily including it in the actual git 1.5.0 tarball?\n\nAs a suggestion, maybe it would be a good idea to actually include it as\nRELEASE-NOTES in the top-level source tree of git. This will make it\nmuch more likely that people packaging git will include in\n/usr/share/doc/git. \n\nOr better yet, maybe we should include it in the Documentation directory\nand set it up to be built as a manpage, git-release-notes. This will\nmake it much more likely that end users who are getting git from their\nFedora, Debian, Red Hat, et. al distribution will actually see the\nrelease notes when they install the new package.\n\nWhat do you think?\n\n\t\t\t\t\t\t- Ted\n"},{"id":"34434","messageId":"7vzm7ix895.fsf@assigned-by-dhcp.cox.net","threadId":"6797","inReplyTo":"E1HGyPn-0003Te-9s@candygram.thunk.org","subject":"Re: Including the release notes in the git-1.5.0 release?","fromName":"Junio C Hamano","fromEmail":"junkio@cox.net","sentAt":"2007-02-13T17:44:22Z","receivedAt":"2007-02-13T17:44:22Z","isPatch":false,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Theodore Ts'o\" writes:\n\n> As a suggestion, maybe it would be a good idea to actually include it as\n> RELEASE-NOTES in the top-level source tree of git. This will make it\n> much more likely that people packaging git will include in\n> /usr/share/doc/git. \n>\n> Or better yet, maybe we should include it in the Documentation directory\n> and set it up to be built as a manpage, git-release-notes. This will\n> make it much more likely that end users who are getting git from their\n> Fedora, Debian, Red Hat, et. al distribution will actually see the\n> release notes when they install the new package.\n\nIndeed I was planning to use it as the announcement message, but\nincluding it in the final tarball sounds sensible.\n\nAs the text assumes familiarity with git 1.3.0 or so, I am not\nsure if making it as one of the manpages makes much sense.\n\nAlso there is a question of what to do when 1.6.0 comes out.\nWill its release notes replace 1.5.0 one? If so changes from\nwhich version will it describe?\n\nI suspect that doing something like:\n\n\tgit cat-file todo:v1.5.0.txt >Documentation/v1.5.0.txt\n\tln -s Documentation/v1.5.0.txt RELEASE-NOTES\n git add RELEASE-NOTES Documentation/v1.5.0.txt\n\nand have pointer to v1.5.0.txt from Documentation/git.txt would\nbe a sensible and easy thing to do.\n"},{"id":"34446","messageId":"20070213180541.GH8670@thunk.org","threadId":"6797","inReplyTo":"7vzm7ix895.fsf@assigned-by-dhcp.cox.net","subject":"Re: Including the release notes in the git-1.5.0 release?","fromName":"Theodore Tso","fromEmail":"tytso@mit.edu","sentAt":"2007-02-13T18:05:41Z","receivedAt":"2007-02-13T18:05:41Z","isPatch":false,"sender":{"key":"tytso@mit.edu","avatar":"https://avatars.githubusercontent.com/u/51416?v=4"},"body":"On Tue, Feb 13, 2007 at 09:44:22AM -0800, Junio C Hamano wrote:\n> As the text assumes familiarity with git 1.3.0 or so, I am not\n> sure if making it as one of the manpages makes much sense.\n\nYeah, that's a good point.\n\n> Also there is a question of what to do when 1.6.0 comes out.\n> Will its release notes replace 1.5.0 one? If so changes from\n> which version will it describe?\n\nWhat I've seen some projects do (including some commercial products)\nis to keep them around with the old file names. So if we have\n\nDocumentation/RELEASE-NOTES_1.5.0.txt\nDocumentation/RELEASE-NOTES_1.6.0.txt\nDocumentation/RELEASE-NOTES_1.7.0.txt\n\nand a symlink from RELEASE-NOTES to Documentation/RELEASE-NOTES-.txt\n\nthat would make a lot of sense....\n\n> and have pointer to v1.5.0.txt from Documentation/git.txt would\n> be a sensible and easy thing to do.\n\nThe only reason why I suggest Documentation/RELEASE-NOTES_1.5.0.txt\ninstead of Documentation/v1.5.0.txt is that it might not be as obvious\nwhat \"v1.5.0.txt\" is for someone just looking at it in the\nDocumntation directory, where as \"RELEASE-NOTES_1.5.0.txt leaves no\ndoubt.\n\nBut keeping the the old release notes around is good both for people\nwho are upgrading from older versions, and it also means that for\nsomeone who wants to answer the question, \"suppose we want to enable\nfeature \", what which older versions of git clients will be\nbreaking. \n\n(I was about to suggest that we just break the older git clients using\ndumb http protecols on kernel.org, befure I realized that that meant\nbreaking git clients that were released last August. Whoops; it's\namazing how much improvements git has seen in the last six months,\nthat it seems a lot longer ago... :-)\n\n\t\t\t\t\t\t\t- Ted\n"},{"id":"34549","messageId":"7vk5ykso02.fsf@assigned-by-dhcp.cox.net","threadId":"6797","inReplyTo":"20070213180541.GH8670@thunk.org","subject":"Re: Including the release notes in the git-1.5.0 release?","fromName":"Junio C Hamano","fromEmail":"junkio@cox.net","sentAt":"2007-02-14T16:27:41Z","receivedAt":"2007-02-14T16:27:41Z","isPatch":false,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Theodore Tso writes:\n\n> What I've seen some projects do (including some commercial products)\n> is to keep them around with the old file names. So if we have\n>\n> Documentation/RELEASE-NOTES_1.5.0.txt\n> Documentation/RELEASE-NOTES_1.6.0.txt\n> Documentation/RELEASE-NOTES_1.7.0.txt\n>\n> and a symlink from RELEASE-NOTES to Documentation/RELEASE-NOTES-.txt\n>\n> that would make a lot of sense....\n\nDone.\n\nI used to like reading pod/perl*delta.pod but these days they\nare tooooo long. Hopefully we can keep our release notes short\nand sweet. \n\nPeople might already have noticed that the latest docs at\n\n\thttp://www.kernel.org/pub/software/scm/git/docs/\n\nhas link to older versions.\n"}]}