Documenting Commits

[Matthew East]

On 22 September 2013 17:04, Doug Smythies <dsmythies at telus.net> wrote:
> There is consensus on:
>
> . The changelog must be updated when the package version of the
> Desktop help docs is going to be updated from the not packaged version.
> This would be a documentation committer requirement, and not of concern
> to documentation contributors.
>
> . The changelog does not have to be updated for every single commit.
>
> There is not consensus on:
>
> . The frequency that the changelog should be updated in the not
> packaged version.

For what it's worth, the practice in the past has always been that the
individual commits did not update the changelog, which was updated
once for each package upload. That way, the changelog in the bzr
branch will generally reflect the archive, which generally makes
sense. This is consistent with the fact that the ubuntu-docs branch is
an upstream project in Launchpad, which is then released into Ubuntu
from time to time, and the changelog relates to Ubuntu releases.

>From a packaging perspective, if this changes so that the changelog
gets updated more frequently than the archive, you can avoid confusion
by setting the distribution value in the changelog to "UNRELEASED" to
reflect that it has not been released into the archive.

Matt