Skip to content

Commit 76d6b57

Browse files
committed
kernelCTF: style guide: further smaller fixes
1 parent 2b1a1ad commit 76d6b57

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

kernelctf/style_guide.md

+19-9
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ mnl_attr_put_u32(nlh, …, htonl(-0x35));
413413

414414
## Naming conventions
415415

416-
Use describing names for including but not limited to: variables, functions, defines.
416+
Use descriptive names for including but not limited to: variables, functions, defines.
417417

418418
Make sure that the name is not misleading.
419419

@@ -597,7 +597,7 @@ void some_func()
597597

598598
## ROP chains
599599

600-
We prefer collecting target related details like symbol, ROP gadget and stack pivot offsets and structure sizes as `#define`s at the top of the file with describing names.
600+
We prefer collecting target related details like symbol, ROP gadget and stack pivot offsets and structure sizes as `#define`s at the top of the file with descriptive names.
601601

602602
The exact kernel symbols names should be used which could be found in the kernel.
603603

@@ -730,7 +730,8 @@ void some_func()
730730
tfd = timerfd_create(CLOCK_MONOTONIC, 0);
731731
732732
} else {
733-
// local variable, conflicts with the other local one
733+
// local variable, conflicts with
734+
// the other local one
734735
int tfd;
735736
736737
// sets a different local variable
@@ -915,7 +916,8 @@ usleep(300*1000);
915916
```c
916917
del_chain(trig_chain_name);
917918
918-
// @sleep(kernel_func="nft_commit_release", desc="wait for victim chain (trig_chain_name) to be freed")
919+
// @sleep(kernel_func="nft_commit_release",
920+
// desc="wait for victim chain (trig_chain_name) to be freed")
919921
usleep(300*1000);
920922
```
921923
</td>
@@ -1053,10 +1055,12 @@ struct nftnl_set * set_elem_triggers[0x200];
10531055

10541056
for(int i = 1 ; i <= 20; i++)
10551057
for (int j = 1 ; j <= 20; j++)
1056-
set_elem_triggers[(i-1) * 20 + (j-1)] = set_elem_trigger;
1058+
set_elem_triggers[(i-1) * 20 + (j-1)] =
1059+
set_elem_trigger;
10571060

10581061
for(int i = 0 ; i < 200; i++)
1059-
nftnl_set_elems_nlmsg_build_payload(nlh, set_elem_triggers[i]);
1062+
nftnl_set_elems_nlmsg_build_payload(nlh,
1063+
set_elem_triggers[i]);
10601064
```
10611065
10621066
The code above:
@@ -1077,10 +1081,12 @@ struct nftnl_set * set_elem_triggers[SPRAY_COUNT];
10771081
10781082
for(int i = 1 ; i <= SPRAY_DIM_X; i++)
10791083
for (int j = 1 ; j <= SPRAY_DIM_Y; j++)
1080-
set_elem_triggers[(i-1) * SPRAY_DIM_Y + (j-1)] = set_elem_trigger;
1084+
set_elem_triggers[(i-1) * SPRAY_DIM_Y + (j-1)] =
1085+
set_elem_trigger;
10811086
10821087
for(int i = 0 ; i < SPRAY_COUNT; i++)
1083-
nftnl_set_elems_nlmsg_build_payload(nlh, set_elem_triggers[i]);
1088+
nftnl_set_elems_nlmsg_build_payload(nlh,
1089+
set_elem_triggers[i]);
10841090
```
10851091
</td>
10861092
</tr>
@@ -1120,7 +1126,7 @@ __u64 lost; // Number of lost events
11201126
</tr>
11211127
</table>
11221128

1123-
## Miscellaneous code quality issues
1129+
## Miscellaneous notes
11241130

11251131
### Code duplication
11261132

@@ -1231,3 +1237,7 @@ static void do_epoll_enqueue(int fd, int f)
12311237
</td>
12321238
</tr>
12331239
</table>
1240+
1241+
### Indentation
1242+
1243+
We prefer 4 spaces.

0 commit comments

Comments
 (0)