From e431d9bad4608ff04104f789cf7c3a385e70537a Mon Sep 17 00:00:00 2001 From: Adriano Garcia Date: Thu, 1 Feb 2024 13:11:44 -0300 Subject: [PATCH] Update 2 files - /docs/source/CLI.rst - /docs/source/new_app.rst --- docs/source/CLI.rst | 2 ++ docs/source/new_app.rst | 6 +++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/source/CLI.rst b/docs/source/CLI.rst index 6d91220..7cd3ef0 100644 --- a/docs/source/CLI.rst +++ b/docs/source/CLI.rst @@ -564,6 +564,8 @@ List applications New application ~~~~~~~~~~~~~~~ +.. _new_app_cmd: + ``./spbench -new-app -h`` **Description:** diff --git a/docs/source/new_app.rst b/docs/source/new_app.rst index d292faf..bb8e540 100644 --- a/docs/source/new_app.rst +++ b/docs/source/new_app.rst @@ -46,12 +46,16 @@ The representation below shows the simplest structure an application can have in |__ app_id_utils.cpp When using the existent benchmarks provided by SPBench, users should be concerned only with the user-side benchmark code. On this side, there is the source code of the operators, besides Source and Sink, and the implementation of the main function. -Modifying the source codes on the system side is necessary to add a new application. The system side includes the implementation of Source and Sink operators, initializing and ending routines, command-line parameters parser, global variable declarations, standard auxiliary functions, etc. +Modifying the source codes on the system side is necessary to add a new application. +The system side includes the implementation of Source and Sink operators, initializing and ending routines, command-line parameters parser, global variable declarations, standard auxiliary functions, etc. It also includes a templates folder. This folder is copied to ``SPBench/app_id/PPI_id/bench_id/`` when users create a new benchmark. So, when adding a new application to SPBench, the developer should be concerned only with the system side. The user-side benchmarks will be automatically created if the developer did everything correctly. To help users/developers add new applications, SPBench implements the ``new-app`` command. + +Run ``./spbench new-app -h`` or check check :doc:`new_app_cmd` for more details. + This command ``./spbench new-app -h`` can generate a sample toy application with a given number of operators. This toy application is perfectly functional, which means it can be used to create, compile, and run a benchmark. However, it does not do any meaningful computation and should not be used for real experimentation. -- GitLab