Sylvain Beucler <[EMAIL PROTECTED]> tapota : >> >> Please, also ALWAYS update ChangeLog.byversion, it saves 1 hour of >> >> really dumb job when making a release. >> > >> > The last 2 commits were really trivial bugfixes (here, a C-k, last >> > time, s/submit=Appliquer/set=custom/). >> > >> > I agree on the principle, and will try to stick with this, but on the >> > other hand, there's no need to go ClearCase-like and take 10 minutes to >> > document each byte I move in the code, is it? >> >> No sure. But a bug that has been fixed may have been found by others >> persons. And they should be able to rely on the ChangeLog.byversion to >> know if the bug they noticed was fixed or not. > > What is ChangeLog.byversion for, actually? > > I though of it as a kind of NEWS file, ie non-trivial changes of > interest for end users.
Any reported bug is non-trivial. > To check if my bug was fixed, I'd point people to ChangeLog. This generated file is useful for developers but you cannot expect users to browse it. >Now maybe you consider this bug is a non-trivial one of interest for >end users, in which case I'll document it. Any bug that have been noticed by one user may have been noticed by someone that did not bothered report it. So I guess that all the reported bug are worth mentioning. > If ChangeLog.byversion is just ChangeLog ordered a bit differently, I > would vote for adding commits with message "Released version 1.0.x" in > ChangeLog, scrap ChangeLog.byversion and avoid duplicating > information. No it is not just ordered differently. The content differ because each items of this changelog reflect a task that have been handled, not the comment of a specific commit. It would tend to be concise, grouping maybe 3 differents items that follow the same general goal (cosmetics etc). The point of the ChangeLog.byversion is to have a file we can give to users that will tell them more or less what changed in the software (changes that are not noticeable by the user, as code cleanups, are not really worth being mentioned there, or just in two words to give the user the feeling that some improvements were actually made even if he cant see it). The point of the ChangeLog is to allow developers to know who did what, which commits have been done exactly in which order. It's an exhaustive list of commits, no matter how important commits are, no matter whether the user actually give a toss about such commits. -- Mathieu Roy +---------------------------------------------------------------------+ | General Homepage: http://yeupou.coleumes.org/ | | Computing Homepage: http://alberich.coleumes.org/ | | Not a native english speaker: | | http://stock.coleumes.org/doc.php?i=/misc-files/flawed-english | +---------------------------------------------------------------------+
