[projects/rc-scripts.git] / DEVELOPMENT

	   READ THIS BEFORE CHANGEING SOMETHING IN RC-SCRIPTS PACKAGE
		    Arkadiusz Miskiewicz <misiek@pld-linux.org>
	    $Id$

1)
	consult all major changes with people on pld-rc-scripts@pld-linux.org
mailing list. This is very important.

2)
	use 'typeset' for local variables in functions for example:

function_ble ()
{
typeset qw er
qw=$(tty)
er=/dev/console
echo "$qw $er"
}

3)
	use $() instead `` for command execution for example

something=$(whoami)
instead of
something="`whoami`"

Warning! The following snippet will not work, use `` in such cases:
There is one ')' too many there.

interfaces_boot=$(
	case $i in
		*ifcfg-lo) continue ;;
	esac
)

4)
	consider using typeset -i variable for integer variables

5)	don't use sed ! It only causes one more Requires.
	Use awk ' { gsub(/pattern/,"replaced"); print $0; } ' for that.
	Also try to replace grep calls with awk calls.
	
6)
	(PL) Tlumaczac komunikaty na PL nalezy uzywac formy bezosobowej np:

uruchamianie uslugi
zamiast
uruchamiam usluge


HOW TO MAKE A RELEASE

- svn up
- make distcheck
- update configure.ac release and commit it
- ./changelog.sh && svn ci ChangeLog
- make dist
- ./make-tag.sh
- upload tarball to distfiles, update rc-scripts.spec:HEAD
Commit	Line	Data
de1fc6ce	1	READ THIS BEFORE CHANGEING SOMETHING IN RC-SCRIPTS PACKAGE
ec8b15cb	2	Arkadiusz Miskiewicz <misiek@pld-linux.org>
9ccfa537	3	$Id$
de1fc6ce JR	4
de1fc6ce JR	5	1)
ec8b15cb	6	consult all major changes with people on pld-rc-scripts@pld-linux.org
de1fc6ce JR	7	mailing list. This is very important.
	8
	9	2)
	10	use 'typeset' for local variables in functions for example:
	11
	12	function_ble ()
	13	{
	14	typeset qw er
	15	qw=$(tty)
	16	er=/dev/console
	17	echo "$qw $er"
	18	}
	19
	20	3)
	21	use $() instead `` for command execution for example
	22
	23	something=$(whoami)
	24	instead of
	25	something="`whoami`"
	26
fcf7cc19 JR	27	Warning! The following snippet will not work, use `` in such cases:
	28	There is one ')' too many there.
	29
	30	interfaces_boot=$(
	31	case $i in
	32	*ifcfg-lo) continue ;;
	33	esac
	34	)
	35
de1fc6ce JR	36	4)
	37	consider using typeset -i variable for integer variables
	38
	39	5) don't use sed ! It only causes one more Requires.
	40	Use awk ' { gsub(/pattern/,"replaced"); print $0; } ' for that.
52c53926	41	Also try to replace grep calls with awk calls.
de1fc6ce	42
7f2422b2	43	6)
de1fc6ce JR	44	(PL) Tlumaczac komunikaty na PL nalezy uzywac formy bezosobowej np:
	45
	46	uruchamianie uslugi
	47	zamiast
	48	uruchamiam usluge
6f90b667 ER	49
	50
	51
	52	HOW TO MAKE A RELEASE
	53
1d3ff153	54	- svn up
6f90b667 ER	55	- make distcheck
6f90b667 ER	56	- update configure.ac release and commit it
1d3ff153	57	- ./changelog.sh && svn ci ChangeLog
6f90b667 ER	58	- make dist
	59	- ./make-tag.sh
	60	- upload tarball to distfiles, update rc-scripts.spec:HEAD