From 35e73f868b5f358d16d3e2b4845fe318545416b1 Mon Sep 17 00:00:00 2001 From: pacien Date: Sat, 2 Dec 2017 01:18:26 +0100 Subject: Update doc topics Signed-off-by: pacien --- doc/topics/Build.txt | 31 ------------------------------- doc/topics/build.txt | 31 +++++++++++++++++++++++++++++++ doc/topics/code-style.txt | 7 ++----- 3 files changed, 33 insertions(+), 36 deletions(-) delete mode 100644 doc/topics/Build.txt create mode 100644 doc/topics/build.txt diff --git a/doc/topics/Build.txt b/doc/topics/Build.txt deleted file mode 100644 index c461434..0000000 --- a/doc/topics/Build.txt +++ /dev/null @@ -1,31 +0,0 @@ -Title: Build - -List of the make targets. The global `make all` and `make clean` are also defined. - - -About: Compiling - -> make source - -Compiles all modules. - - -About: Automatic tests - -> make test - -Compiles and runs all unit tests. - - -About: API documentation - -> make api-doc - -Generates the HTML API documentation with Natural Docs v1.5. - - -About: Project report - -> make report - -Generates the project report using Pandoc. diff --git a/doc/topics/build.txt b/doc/topics/build.txt new file mode 100644 index 0000000..c461434 --- /dev/null +++ b/doc/topics/build.txt @@ -0,0 +1,31 @@ +Title: Build + +List of the make targets. The global `make all` and `make clean` are also defined. + + +About: Compiling + +> make source + +Compiles all modules. + + +About: Automatic tests + +> make test + +Compiles and runs all unit tests. + + +About: API documentation + +> make api-doc + +Generates the HTML API documentation with Natural Docs v1.5. + + +About: Project report + +> make report + +Generates the project report using Pandoc. diff --git a/doc/topics/code-style.txt b/doc/topics/code-style.txt index 45318ab..25b3b3e 100644 --- a/doc/topics/code-style.txt +++ b/doc/topics/code-style.txt @@ -27,8 +27,5 @@ About: Code structure - It is advised to declare variables on the stack instead of the heap when possible. - The use of `assert` is encouraged. - The use of `static` functions is encouraged. Such members must be declared prior to others. - - -About: Unit tests - -- Unit test files have the `.test.c` extension. +- Imports should be thematically sorted, with the current spec file listed first, followed by external imports, + then internal imports -- cgit v1.2.3