1.10.20

[platform/upstream/dbus.git] / HACKING

diff --git a/HACKING b/HACKING
index e776fd6..45f34f7 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -11,6 +11,11 @@ of patches, etc. should go there.
 Security
 ===
 
+If you find a security vulnerability that is not known to the public,
+please report it privately to dbus-security@lists.freedesktop.org
+or by reporting a freedesktop.org bug that is marked as
+restricted to the "D-BUS security group".
+
 Most of D-Bus is security sensitive.  Guidelines related to that:
 
  - avoid memcpy(), sprintf(), strlen(), snprintf, strlcat(),
@@ -63,15 +68,15 @@ Development
 ===
 
 D-Bus uses Git as its version control system. The main repository is
-hosted at git.freedesktop.org/dbus/dbus. To clone D-Bus, execute the
-following command:
+hosted on freedesktop.org. To clone D-Bus, execute one of the
+following commands:
 
-    git clone git://git.freedesktop.org/dbus/dbus
-OR
-    git clone git.freedesktop.org:dbus/dbus
+    git clone https://anongit.freedesktop.org/git/dbus/dbus.git
+    git clone git://anongit.freedesktop.org/dbus/dbus
+    git clone ssh://git.freedesktop.org/git/dbus/dbus
 
-The latter form is the one that allows pushing, but it also requires
-an SSH account on the server. The former form allows anonymous
+The last form is the one that allows pushing, but it also requires
+an SSH account on the server. The other forms allow anonymous
 checkouts.
 
 D-Bus development happens in two branches in parallel: the current
@@ -208,16 +213,19 @@ To make a release of D-Bus, do the following:
  - post to dbus@lists.freedesktop.org announcing the release.
  
 
-After making a ".0" stable release
+Making a ".0" stable release
 ===
 
-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.
+We create a branch for each stable release. The branch name should be
+dbus-X.Y which is a branch that has releases versioned X.Y.Z;
+changes on a stable branch should be limited to significant bug fixes.
+
+Because we won't make minor changes like keeping up with the latest
+deprecations on a stable branch, stable branches should turn off the
+gcc warning for deprecated declarations (e.g. see commit 4ebb275ab7).
 
-The branch name should be dbus-X.Y which is a branch that has
-releases versioned X.Y.Z
+Be extra-careful not to merge master (or any branch based on master) into a
+stable branch.
 
 To branch:
   git branch dbus-X.Y
@@ -264,7 +272,7 @@ Tests
 These are the test programs that are built if dbus is compiled using
 --enable-tests.
 
-dbus/dbus-test
+dbus/test-dbus
 This is the main unit test program that tests all aspects of the D-Bus
 client library.