X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=rt%2Fdocs%2Fhacking.pod;h=23ce51e3a619db835fabec1f58fed928f56228aa;hb=53846367793e58f00ce32b2fcbd05e9f0ddd179e;hp=8aa84fd019be815f4d4ca4cee5c23cca2c9227d4;hpb=6587f6ba7d047ddc1686c080090afe7d53365bd4;p=freeside.git diff --git a/rt/docs/hacking.pod b/rt/docs/hacking.pod index 8aa84fd01..23ce51e3a 100644 --- a/rt/docs/hacking.pod +++ b/rt/docs/hacking.pod @@ -38,7 +38,9 @@ For example, a bugfix branched from C<4.0-trunk> might be named C<4.0/fail-taint-mode-early>. A feature branched from C when there exists a C<4.0-trunk> but no C<4.2-trunk> might be named C<4.2/rename-LogToScreen>. For consistency, branches should use dashes, -not underscores, to separate words. +not underscores, to separate words. Branches which are destined for +4.2, but which are branched from 4.0 (to provide for easy extraction as +a 4.0 extension) should be named 4.2-on-4.0/branch-name. Branches should be reviewed by another developer before being merged. Reviewers should make sure that the branch accomplishes what it claims @@ -151,8 +153,14 @@ C<#loc_left_pair> is used for declaring that the I of a particular C<< key => value >> pair is translatable. This is of very limited usefulness. -C<#loc_right_pair> does NOT exist. C<#loc> works in such cases since -its parser does not extend beyond the string at the end of a line. +C<#loc_right_pair> does NOT exist. C<#loc> works in such cases since its +parser does not extend beyond the string at the end of a line. However, +if the string is I at the end of the line, C<#loc{word}> declares +that the value associated with the key I (earlier on the same +line) is to be loc'd. This is useful for inline hashes: + + # Note the string "baz" is to be loc'd + foo => { bar => "baz", troz => "zort" }, # loc{bar} =head1 Development tips @@ -170,7 +178,7 @@ can create and drop databases: You'll need to configure RT and make sure you have all the dependencies before running tests. To do this in place without installing: - ./configure.ac --with-my-user-group --enable-layout=inplace --with-devel-mode + ./configure.ac --with-my-user-group --enable-layout=inplace --enable-developer make testdeps make fixdeps @@ -186,11 +194,11 @@ which will be significantly faster: make test-parallel -The C<*-trunk> and C branches are expected to be passing always -be passing all tests. While it is acceptable to break tests in an -intermediate commit, a branch which does not pass tests will not be -merged. Ideally, commits which fix a bug should also include a testcase -which fails before the fix and succeeds after. +The C<*-trunk> and C branches are expected to always be passing +all tests. While it is acceptable to break tests in an intermediate +commit, a branch which does not pass tests will not be merged. Ideally, +commits which fix a bug should also include a testcase which fails +before the fix and succeeds after.