Prepare version 1.4.4
[platform/upstream/dbus.git] / HACKING
diff --git a/HACKING b/HACKING
index f1e9d76..4a561f2 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -152,17 +152,13 @@ To make a release of D-Bus, do the following:
  - verify that the libtool versioning/library soname is 
    changed if it needs to be, or not changed if not
 
- - update the file NEWS based on the ChangeLog
+ - update the file NEWS based on the git history
 
- - update the AUTHORS file based on the ChangeLog
+ - update the AUTHORS file with "make update-authors" if necessary
 
- - add a ChangeLog entry containing the version number 
-   you're releasing ("Released 0.3" or something)
-   so people can see which changes were before and after
-   a given release
-
- - the version number should have major.minor.micro even
-   if micro is 0, i.e. "1.0.0" and "1.2.0" not "1.0"/"1.2"
+ - the version number should have major.minor.micro, even
+   if micro is 0, i.e. "1.0.0" and "1.2.0" not "1.0"/"1.2"; the micro
+   version should be even for releases, and odd for intermediate snapshots
 
  - "make distcheck" (DO NOT just "make dist" - pass the check!)
 
@@ -173,10 +169,11 @@ To make a release of D-Bus, do the following:
 
  - tag the tree with "git tag -s -m 'Released X.Y.Z' dbus-X.Y.Z"
    where X.Y.Z is the version of the release.  If you can't sign
-   then simply created an unannotated tag: "git tag dbus-X.Y.Z".
+   then simply created an unsigned annotated tag:
+   "git tag -a -m 'Released X.Y.Z' dbus-X.Y.Z".
 
- - bump the version number up in configure.in, and commit
-   it.  Make sure you do this *after* tagging the previous
+ - bump the version number up in configure.in (so the micro version is odd),
+   and commit it.  Make sure you do this *after* tagging the previous
    release! The idea is that git has a newer version number
    than anything released.
 
@@ -187,9 +184,11 @@ To make a release of D-Bus, do the following:
  - push your changes and the tag to the central repository with
      git push origin master dbus-X.Y dbus-X.Y.Z
 
- - scp your tarball to freedesktop.org server and copy it 
-   to /srv/dbus.freedesktop.org/www/releases/dbus. This should 
-   be possible if you're in group "dbus"
+ - scp your tarball to freedesktop.org server and copy it to
+   dbus.freedesktop.org:/srv/dbus.freedesktop.org/www/releases/dbus/dbus-X.Y.Z.tar.gz.
+   This should be possible if you're in group "dbus"
+
+ - Update the online documentation with `make -C doc maintainer-upload-docs`.
 
  - update the wiki page http://www.freedesktop.org/Software/dbus by
    adding the new release under the Download heading. Then, cut the
@@ -207,29 +206,21 @@ To make a release of D-Bus, do the following:
 After making a ".0" stable release
 ===
 
-After releasing, when you increment the version number in git, also
-move the ChangeLog to ChangeLog.pre-X-Y where X-Y is what you just
-released, e.g. ChangeLog.pre-1-0. Then create and cvs add a new empty
-ChangeLog. The last entry in ChangeLog.pre-1-0 should be the one about
-"Released 1.0". 
-
-Add ChangeLog.pre-X-Y to EXTRA_DIST in Makefile.am.
-
 We create a branch for each stable release; sometimes the branch is
 not done immediately, instead it's possible to wait until someone has
 a not-suitable-for-stable change they want to make and then branch to
 allow committing that change.
 
-The branch name should be dbus-X.Y-branch which is a branch that has
+The branch name should be dbus-X.Y which is a branch that has
 releases versioned X.Y.Z
 
 To branch:
-  git branch dbus-X.Y-branch
+  git branch dbus-X.Y
 and upload the branch tag to the server:
-  git-push origin dbus-X.Y-branch
+  git push origin dbus-X.Y
 
 To develop in this branch:
-  git-checkout dbus-X.Y-branch
+  git checkout dbus-X.Y
 
 Environment variables
 ===
@@ -286,10 +277,8 @@ is to add a test in here.
 
 "make check" runs all the deterministic test programs (i.e. not break-loader).
 
-"make check-coverage" is available if you configure with --enable-gcov and 
-gives a complete report on test suite coverage. You can also run 
-"test/decode-gcov foo.c" on any source file to get annotated source, 
-after running make check with a gcov-enabled tree.
+"make lcov-check" is available if you configure with --enable-compiler-coverage
+and gives a complete report on test suite coverage.
 
 Patches
 ===