5918aae8 |
1 | this file explains my workflow/structuring habits and is meant only to |
2 | save mentor's time. ideally, this file will be deleted before "release" |
3 | and all files will follow standard protocol/KNF. |
4 | ------------------------------------------------------------------------ |
5 | FILESYSTEM |
6 | |
7 | /src - source files |
9fd3f859 |
8 | /src/modules/logind - obvious |
9 | /src/modules/hostnamed - obvious |
10 | /src/modules/localed - obvious |
11 | /src/modules/timedated - obvious |
5918aae8 |
12 | /bin - dir for compiled test binaries, will eventually be build tmp dir |
13 | /build - build dir |
9fd3f859 |
14 | /scripts - test scripts, mostly python scripts for gdb |
5918aae8 |
15 | ------------------------------------------------------------------------ |
16 | TODO |
17 | |
18 | i keep a general informal list of TODO tasks in /TODO, as well as inline |
19 | TODOs in source. TODO tasks must be single line as the are delimited by |
20 | a newline character, this makes it so one can easily grep for TODO: and |
21 | get complete output. before release, /TODO should be deleted and "TODO:" |
22 | should never appear anywhere in any file. |
23 | |
24 | additionally, any questions for mentors are written as comments and end |
25 | in ajacoutot@ or landry@, i use these if i can't catch y'all on IRC :) |
26 | ------------------------------------------------------------------------ |
27 | ETC |
28 | |
29 | * make sure to end files newlines as their abscence confuses git |
30 | |