[Rt-commit] rt branch, 4.0/hacking-docs, updated. rt-4.0.0rc6-104-g4f9e106

[Thomas Sibley]

The branch, 4.0/hacking-docs has been updated
       via  4f9e106f2325af804acde64af7f296adf16dc1dc (commit)
       via  a57da599e74e1e1811ae19d613d1248b4b28028a (commit)
       via  c789e14bb8adc6d0dd5102fab1cfbe57503996a6 (commit)
       via  25de4fb20e2d9b300cffcfb5d674a916fc22da02 (commit)
      from  f9b0b74110a303439c08b9a0fc1348ad3544dd8c (commit)

Summary of changes:
 docs/hacking.pod |   32 ++++++++++++++++++++------------
 1 files changed, 20 insertions(+), 12 deletions(-)

- Log -----------------------------------------------------------------
commit 25de4fb20e2d9b300cffcfb5d674a916fc22da02
Author: Thomas Sibley <trs at bestpractical.com>
Date:   Tue May 10 13:04:23 2011 -0400

    Encourage branching from the discovery point of the bug
    
    This hopefully means we won't get 3.4 patches or some crazy.

diff --git a/docs/hacking.pod b/docs/hacking.pod
index 26a45c1..2ce8f8e 100644
--- a/docs/hacking.pod
+++ b/docs/hacking.pod
@@ -29,7 +29,8 @@ C<4.0.0-releng>.
 
 New feature development should always be based off of the C<master>
 branch.  Branches to fix bugs should be based off of whichever trunk the
-bug originated in.
+bug was first found in.  If you found the bug in your RT 4.0.0 install,
+you'd branch from 4.0-trunk.
 
 Feature branches should be named based on the trunk they are branched
 from -- which is to say, the earliest branch they might be merged into.

commit c789e14bb8adc6d0dd5102fab1cfbe57503996a6
Author: Thomas Sibley <trs at bestpractical.com>
Date:   Tue May 10 13:05:42 2011 -0400

    Remove an ambiguous pronoun

diff --git a/docs/hacking.pod b/docs/hacking.pod
index 2ce8f8e..e434fcf 100644
--- a/docs/hacking.pod
+++ b/docs/hacking.pod
@@ -51,7 +51,8 @@ not include extranous changes.
 
 The RT codebase is more than ten years old; as such, there are sections
 which do not (yet) conform to the guidelines below.  Please attempt to
-follow them, even if the code surrounding your changes does not yet.
+follow the guidelines, even if the code surrounding your changes does
+not yet.
 
 RT also includes a F<.perltidyrc> in its top-level which encodes many of
 the conventions.

commit a57da599e74e1e1811ae19d613d1248b4b28028a
Author: Thomas Sibley <trs at bestpractical.com>
Date:   Tue May 10 13:06:37 2011 -0400

    Note the need to configure RT and use make test targets instead of prove
    
    make test is a lot easier to type than the prove command

diff --git a/docs/hacking.pod b/docs/hacking.pod
index e434fcf..c47373c 100644
--- a/docs/hacking.pod
+++ b/docs/hacking.pod
@@ -72,25 +72,31 @@ used for indentation.
 
 =head2 Setting up a development environment
 
-=head2 Testsuite
+=head2 Test suite
 
-RT also comes with a fairly complete testsuite.  To run it, you will
+RT also comes with a fairly complete test suite.  To run it, you will
 need to set environment variables to a database user and password which
 can create and drop databases:
 
     export RT_DBA_USER=root
     export RT_DBA_PASSWORD=
 
-To run the testsuite:
+You'll need to configure RT before running tests.  To do this in place
+without installing:
 
-    prove -l t/*,t t/*/*.t
+    ./configure.ac --with-my-user-group --enable-layout=inplace
 
-If you have multiple processors, you can run the testsuite in parallel,
-which will be significantly faster (obviously, adjust the parameter to
-C<-j> as necessary):
+Adjust the relevant database options as necessary if you want to test on
+Postgres, Oracle, or SQLite.  The default is MySQL.
 
-    export RT_TEST_PARALLEL=1
-    prove -l -j5 t/*.t t/*/*.t
+To run the test suite:
+
+    make test
+
+If you have multiple processors, you can run the test suite in parallel,
+which will be significantly faster:
+
+    make test-parallel
 
 The C<*-trunk> and C<master> branches are expected to be passing always
 be passing all tests.  While it is acceptable to break tests in an

commit 4f9e106f2325af804acde64af7f296adf16dc1dc
Author: Thomas Sibley <trs at bestpractical.com>
Date:   Tue May 10 13:07:51 2011 -0400

    Don't force a branch rename in case the reader uses a generic name twice

diff --git a/docs/hacking.pod b/docs/hacking.pod
index c47373c..a7ee252 100644
--- a/docs/hacking.pod
+++ b/docs/hacking.pod
@@ -147,7 +147,7 @@ Give your branch a name based on what you are attempting to accomplish.
 We suggest that branch names be lower-case and separate words with
 dashes, but this branch name is purely for your own reference.
 
-    git branch -M gnupg-encryption
+    git branch -m gnupg-encryption
 
 =item 6.
 

-----------------------------------------------------------------------