From e5636be5b5f8f8b588c8b53c8f269c710305d652 Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Sun, 1 Mar 2026 20:00:37 +0100 Subject: chore: update documentation. Signed-off-by: Amlal El Mahrouss --- doc/cpp_style.md | 17 ----------------- doc/specs/SPECIFICATION_MACROS.md | 1 + doc/style/cpp_style.md | 17 +++++++++++++++++ 3 files changed, 18 insertions(+), 17 deletions(-) delete mode 100644 doc/cpp_style.md create mode 100644 doc/style/cpp_style.md diff --git a/doc/cpp_style.md b/doc/cpp_style.md deleted file mode 100644 index 3069285e..00000000 --- a/doc/cpp_style.md +++ /dev/null @@ -1,17 +0,0 @@ -# NeKernel C++ Style Guide: - -## The Basics: - -NeKernel uses the Google C++ Style. But applied to low-level systems. We use C++20 and later throughout all of our stack. As we keep iterating over time we will amend this document. - -## No Exceptions, Never. - -NeKernel bans the usage of exceptions in ne_kernel, ne_bootz, etc. -Unless it is a program space and not to be deemed performance dependent. - -## Templates, Containers, and ZOA over C with Classes. - -NeKernel doesn't limit itself to a C++ paradigm, as we may find fitting solutions by exploring other patterns. -That is why we have such containers like TrueResult, FalseResult, etc... - - diff --git a/doc/specs/SPECIFICATION_MACROS.md b/doc/specs/SPECIFICATION_MACROS.md index 3b091454..5b2336ea 100644 --- a/doc/specs/SPECIFICATION_MACROS.md +++ b/doc/specs/SPECIFICATION_MACROS.md @@ -18,6 +18,7 @@ The NeKernel System uses macro to configure its compilation. Some of them shall - `__nekernel_halkit_include_processor` HALKit include directory for Processor.h - `__nekernel_dma_pool_start` NeKernel DMA pool start. - `__nekernel_dma_pool_size` NeKernel DMA pool size. +- `__nekernel_dma_best_align` NeKernel Best DMA align size. =================================== diff --git a/doc/style/cpp_style.md b/doc/style/cpp_style.md new file mode 100644 index 00000000..3069285e --- /dev/null +++ b/doc/style/cpp_style.md @@ -0,0 +1,17 @@ +# NeKernel C++ Style Guide: + +## The Basics: + +NeKernel uses the Google C++ Style. But applied to low-level systems. We use C++20 and later throughout all of our stack. As we keep iterating over time we will amend this document. + +## No Exceptions, Never. + +NeKernel bans the usage of exceptions in ne_kernel, ne_bootz, etc. +Unless it is a program space and not to be deemed performance dependent. + +## Templates, Containers, and ZOA over C with Classes. + +NeKernel doesn't limit itself to a C++ paradigm, as we may find fitting solutions by exploring other patterns. +That is why we have such containers like TrueResult, FalseResult, etc... + + -- cgit v1.2.3