openrc/STYLE
Roy Marples 5af58b4514 Rewrite the core parts in C. We now provide librc so other programs can
query runlevels, services and state without using bash. We also provide
libeinfo so other programs can easily use our informational functions.

As such, we have dropped the requirement of using bash as the init script
shell. We now use /bin/sh and have strived to make the scripts as portable
as possible. Shells that work are bash and dash. busybox works provided
you disable s-s-d. If you have WIPE_TMP set to yes in conf.d/bootmisc you
should disable find too.
zsh and ksh do not work at this time.

Networking support is currently being re-vamped also as it was heavily bash
array based. As such, a new config format is available like so
config_eth0="1.2.3.4/24 5.6.7.8/16"
or like so
config_eth0="'1.2.3.4 netmask 255.255.255.0' '5.6.7.8 netmask 255.255.0.0'"

We will still support the old bash array format provided that /bin/sh IS
a link it bash.

ChangeLog for baselayout-1 can be found in our SVN repo.
2007-04-05 11:18:42 +00:00

54 lines
1.5 KiB
Plaintext

This is the rc-scripts style manual. It governs the coding style
of rc-scripts. Everything here might as well have been spoken by
God. If you find any issues, please talk to base-system@gentoo.org
or #gentoo-base on irc.freenode.net.
#############
# VARIABLES #
#############
- User Variables -
Variables must always be enclosed by {}
e.g. ${foo} ${bar}
- Internal Shell Variables -
Do not use {} with internal variables unless appropriate
e.g. case $1 in
e.g. foo=$IFS
e.g. echo "blah${1}123"
- Assigning with Quotes -
When assigning to a variable from another variable, you should
not need quotes. However, you do when assigning from a subshell.
e.g. foo=${bar}
e.g. foo="$(uname -a)"
#########
# TESTS #
#########
- Brackets -
Always use the [ ... ] form instead of [[ ... ]] as the later only really
works in bash, and we should support as many shells as we can.
- Quoting -
When dealing with strings, you should quote both sides.
###############
# CODE BLOCKS #
###############
- Structure -
Use the more compact form
e.g. if ... ; then
e.g. while ... ; do
Do not use the older form
e.g. if ...
then
- Functions -
Use the more compact form
e.g. foo() {
Do not lead with 'function '
e.g. function foo() {
############
# COMMENTS #
############
- General -
Try to include a comment block before sections
of code to explain what you're attempting