cvs: /php4 README.CVS-RULES

andrei Fri Oct 8 09:59:57 1999 EDT Modified files: /php4 README.CVS-RULES Log: More information on how to use the special prefixes and the frequency of NEWS and ChangeLog updates. Index: php4/README.CVS-RULES diff -u php4/README.CVS-RULES:1.1 php4/README.CVS-RULES:1.2 --- php4/README.CVS-RULES:1.1 Thu Oct 7 17:38:22 1999 +++ php4/README.CVS-RULES Fri Oct 8 09:59:27 1999 @@ -49,7 +49,7 @@ in the message as shown below. 5. In your commit messages, keep each line shorter than 80 characters. And - Try to align your lines vertically, if they wrap. It looks bad otherwise. + try to align your lines vertically, if they wrap. It looks bad otherwise. 6. If you modified a function that is callable from PHP, prepend PHP to the function name as shown below. @@ -59,8 +59,11 @@ If a line begins with #, it is taken to be a comment and will not appear in the ChangeLog. If the line begins with @, it will be redirected to the -NEWS file. Everything else goes into the ChangeLog. +NEWS file. Everything else goes into the ChangeLog. +It is important to note that if your comment or news logline spans multiple +lines, you have to put # or @ at the beginning of _every_ such line. + Example. Say you modified two files, datetime.c and string.c. In datetime.c you added a new format option for date() function, and in string.c you fixed a memory leak in php_trim(). Don't commit both of these at once. Commit them @@ -70,9 +73,9 @@ For datetime.c: (PHP date) Added new 'K' format modifier for printing out number of - days until New Year. + days until New Year's Eve. @- Added new 'K' format modifier that will output the number of days - until Christmas. (Bob) +@ until New Year's Eve. (Bob) For string.c: (php_trim) Fixed a memory leak resulting from improper use of zval_dtor(). @@ -80,8 +83,10 @@ @- Memory leak in trim() function has finally been fixed. (Bob) The lines above marked with @ will go into NEWS file automagically, and the -# line will be omitted from the ChangeLog. Alternatively, you might want -to modify NEWS file directly and not use the @ lines. +# lines will be omitted from the ChangeLog. Alternatively, you might want +to modify NEWS file directly and not use the @ lines. Since ChangeLog and +NEWS are updated once a day, the lines you prefixed with @ may not show up +until somewhat later. Happy hacking,