From 85e3987588f60aeb9e79d51ea8b3e26e3d8a3256 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20=C5=BBygowski?= Date: Tue, 30 May 2023 17:59:06 +0200 Subject: [PATCH] docs/source/design.rst: finalize design rules MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michał Żygowski --- docs/source/design.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/source/design.rst b/docs/source/design.rst index a286006..7c8498d 100644 --- a/docs/source/design.rst +++ b/docs/source/design.rst @@ -17,7 +17,11 @@ Dasharo Openness Score general rules closed-source and open-source code only * Markdown report should print general image statistics and any additional statistic per region or firmware integral part (firmware image type - dependent). + dependent) includign the category the component has been classified + * General image statistic at minimum are: image size, open-source size, + closed-source size, data size and empty size + +3. The utility must be sa precise as possible to avoid falsified results. Dasharo Openness Score module design rules ------------------------------------------ @@ -43,4 +47,5 @@ Each class representing a firmware image (or its integral part): ``__init__`` method 9. Must implement ``export_charts`` method to generate pie charts (only for classes representing the whole firmware image) - +10. Must assume a component as closed-source if unable to classify to any + category.