experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Docs: C struct style

Browse source 
Tests: changed waiting->wait backend
This commit is contained in:
Olof hagsand 2022-10-24 13:54:02 +02:00
parent 62e652bbcf
commit 3a5d156690
33 changed files with 60 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

27
doc/DEVELOP.md
View file

@ -47,15 +47,14 @@ myfn(int par1,
ms = NULL; ms = NULL;
``` ```
Notes: Notes:
1. the return type of the function and all qualifers on first line (`static int`) 1. The return type of the function and all qualifers on first line (`static int`)
2. function name and first parameter on second line, thereafter each parameter on own line 2. Function name and first parameter on second line, thereafter each parameter on own line
3. Each parameter indented to match the "longest" (`my_structure`) 3. Each parameter indented to match the "longest" (`my_structure`)
4. Pointer declarations written: `type *p`, not: `type* p`. 4. Pointer declarations written: `type *p`, not: `type* p`.
5. All local variables in a function declared at top of function, not inline with C-statements. 5. All local variables in a function declared at top of function, not inline with C-statements.
6. Local variables can be initialized with scalars or constants, not eg malloc or functions with return values that need to be checked for errors 6. Local variables can be initialized with scalars or constants, not eg malloc or functions with return values that need to be checked for errors
7. There is a single empty line between local variable declarations and the first function statement. 7. There is a single empty line between local variable declarations and the first function statement.
Function signatures are declared in include files or in forward declaration using "one-line" syntax, unless very long: Function signatures are declared in include files or in forward declaration using "one-line" syntax, unless very long:
``` ```
static int myfn(int par1, my_structure *par2); static int myfn(int par1, my_structure *par2);
@ -123,6 +122,28 @@ files, there is only a single level of include file dependencies.
The drawback is that the same include file may need to be repeated in many .c files. The drawback is that the same include file may need to be repeated in many .c files.
### Structs
Struct fields should have a prefix to distinguish them from other struct fields. The prefix should use an abbreviation of the struct name.
Example:
```
struct my_struct{
int ms_foo;
char *ms_string[42];
}
```
where `ms_` is the prefix and is an abbreviation of `my_struct`.
### Global variables
Try to avoid global variables.
If you absolutely need one, try to contain it as static within a
single C-file, ie do not declare it extern and use it elsewhere.
Also, always prepend a global variable with `_`, underscore.
## How to work in git ## How to work in git
Clixon uses semantic versioning (https://semver.org). Clixon uses semantic versioning (https://semver.org).

2
test/test_api.sh
View file

@ -228,7 +228,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

3
test/test_augment_state.sh
View file

@ -144,7 +144,8 @@ if [ $BE -ne 0 ]; then
new "start backend -s init -f $cfg -- -sS $fstate" new "start backend -s init -f $cfg -- -sS $fstate"
start_backend -s init -f $cfg -- -sS $fstate start_backend -s init -f $cfg -- -sS $fstate
fi fi
new "waiting"
new "wait backend"
wait_backend wait_backend
#----------------------------- #-----------------------------

3
test/test_augment_trans.sh
View file

@ -109,7 +109,8 @@ if [ $BE -ne 0 ]; then
new "start backend -s init -f $cfg" new "start backend -s init -f $cfg"
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting"
new "wait backend"
wait_backend wait_backend
new "get-config empty" new "get-config empty"

2
test/test_client.sh
View file

@ -138,7 +138,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_identity.sh
View file

@ -197,7 +197,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_leafref_uses_augment.sh
View file

@ -114,7 +114,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
new "cli set t1-con t1-con t1-a 123" new "cli set t1-con t1-con t1-a 123"

2
test/test_nacm.sh
View file

@ -123,7 +123,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_nacm_credentials.sh
View file

@ -135,7 +135,7 @@ EOF
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
# First push in nacm rules via regular means # First push in nacm rules via regular means

2
test/test_nacm_datanode.sh
View file

@ -226,7 +226,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_nacm_datanode_paths.sh
View file

@ -100,7 +100,7 @@ if [ $BE -ne 0 ]; then
start_backend -s startup -f $cfg start_backend -s startup -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_nacm_datanode_read.sh
View file

@ -231,7 +231,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_nacm_datanode_write.sh
View file

@ -227,7 +227,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_nacm_ext.sh
View file

@ -191,7 +191,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg -- -s start_backend -s init -f $cfg -- -s
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_nacm_module_read.sh
View file

@ -184,7 +184,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg -- -s start_backend -s init -f $cfg -- -s
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_nacm_protocol.sh
View file

@ -145,7 +145,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_netconf_filter.sh
View file

@ -56,7 +56,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
new "Add two entries" new "Add two entries"

2
test/test_netconf_notifications.sh
View file

@ -101,7 +101,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg -- -n # create example notification stream start_backend -s init -f $cfg -- -n # create example notification stream
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
# #

2
test/test_netconf_whitespace.sh
View file

@ -73,7 +73,7 @@ if [ $BE -ne 0 ]; then
start_backend -s startup -f $cfg start_backend -s startup -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
new "get startup" new "get startup"

2
test/test_perf_cli.sh
View file

@ -83,7 +83,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg -- -s start_backend -s init -f $cfg -- -s
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
new "generate config with $perfnr list entries" new "generate config with $perfnr list entries"

2
test/test_perf_mem.sh
View file

@ -85,7 +85,7 @@ function testrun(){
start_backend -s startup -f $cfg start_backend -s startup -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
pid=$(cat $pidfile) pid=$(cat $pidfile)

2
test/test_perf_netconf.sh
View file

@ -87,7 +87,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg -- -s start_backend -s init -f $cfg -- -s
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
# Check this later with committed data # Check this later with committed data

2
test/test_perf_restconf.sh
View file

@ -106,7 +106,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg -- -s start_backend -s init -f $cfg -- -s
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_perf_restconf_ssl.sh
View file

@ -122,7 +122,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg -- -s start_backend -s init -f $cfg -- -s
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_privileges.sh
View file

@ -96,7 +96,7 @@ function testrun(){
err 1 $c err 1 $c
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $expecterr -eq 1 ]; then if [ $expecterr -eq 1 ]; then

2
test/test_restconf_notifications.sh
View file

@ -149,7 +149,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg -- -n # create example notification stream start_backend -s init -f $cfg -- -n # create example notification stream
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_rpc.sh
View file

@ -196,7 +196,7 @@ if [ $BE -ne 0 ]; then
start_backend -s init -f $cfg start_backend -s init -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
if [ $RC -ne 0 ]; then if [ $RC -ne 0 ]; then

2
test/test_startup.sh
View file

@ -124,7 +124,7 @@ function testrun(){
new "start backend -f $cfg -s $mode -c $dir/extra_db" new "start backend -f $cfg -s $mode -c $dir/extra_db"
start_backend -s $mode -f $cfg -c $dir/extra_db start_backend -s $mode -f $cfg -c $dir/extra_db
new "waiting" new "wait backend"
wait_backend wait_backend
else else
new "Restart backend as eg follows: -Ff $cfg -s $mode -c $dir/extra_db # $BETIMEOUT s" new "Restart backend as eg follows: -Ff $cfg -s $mode -c $dir/extra_db # $BETIMEOUT s"

2
test/test_upgrade_auto.sh
View file

@ -258,7 +258,7 @@ if [ $BE -ne 0 ]; then
start_backend -s $mode -f $cfg start_backend -s $mode -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
new "Check running db content" new "Check running db content"

2
test/test_upgrade_interfaces.sh
View file

@ -271,7 +271,7 @@ function testrun(){
start_backend -s startup -f $cfg -- -u start_backend -s startup -f $cfg -- -u
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
new "Check running db content" new "Check running db content"

2
test/test_upgrade_interfaces_rfc7895.sh
View file

@ -268,7 +268,7 @@ function testrun(){
start_backend -s startup -f $cfg -- -u start_backend -s startup -f $cfg -- -u
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
new "Check running db content" new "Check running db content"

2
test/test_upgrade_repair.sh
View file

@ -117,7 +117,7 @@ if [ $BE -ne 0 ]; then
start_backend -s $mode -f $cfg start_backend -s $mode -f $cfg
fi fi
new "waiting" new "wait backend"
wait_backend wait_backend
new "Check running db content is failsafe" new "Check running db content is failsafe"

6
test/test_upgrade_simple.sh
View file

@ -111,11 +111,11 @@ EOF
if [ $BE -ne 0 ]; then if [ $BE -ne 0 ]; then
new "start backend -s running -f $cfg" new "start backend -s running -f $cfg"
start_backend -s running -f $cfg start_backend -s running -f $cfg
new "waiting"
wait_backend
fi fi
new "wait backend"
wait_backend
new "netconf get config" new "netconf get config"
expecteof_netconf "$clixon_netconf -qf $cfg" 0 "$DEFAULTHELLO" "<rpc $DEFAULTNS><get-config><source><candidate/></source></get-config></rpc>" "" "<rpc-reply $DEFAULTNS><data><hello xmlns=\"urn:example:simple\"><world/></hello></data></rpc-reply>" expecteof_netconf "$clixon_netconf -qf $cfg" 0 "$DEFAULTHELLO" "<rpc $DEFAULTNS><get-config><source><candidate/></source></get-config></rpc>" "" "<rpc-reply $DEFAULTNS><data><hello xmlns=\"urn:example:simple\"><world/></hello></data></rpc-reply>"