Skip to content

Commit 56c93c1

Browse files
committed
doc: update demo_profiling comments and user doc
Signed-off-by: Huaqi Fang <[email protected]>
1 parent 5aaae0d commit 56c93c1

File tree

4 files changed

+11
-4
lines changed

4 files changed

+11
-4
lines changed

application/baremetal/demo_profiling/Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Please use it in Nuclei Studio IDE not in command line
2+
# see https://doc.nucleisys.com/nuclei_sdk/design/app.html#demo-profiling
13
TARGET = demo_profiling
24

35
MIDDLEWARE := profiling

application/baremetal/demo_profiling/main.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ static int test_decrypt_ecb(void);
3636
#define AES_DEBUG(fmt, ...)
3737
#endif
3838

39+
// TODO: Please use this example in Nuclei Studio IDE, never use it in command line
40+
// see https://doc.nucleisys.com/nuclei_sdk/design/app.html#demo-profiling
3941
int main(void)
4042
{
4143
int exit = 0;

doc/source/design/app.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1691,14 +1691,15 @@ console when main part code is executed.
16911691

16921692
.. note::
16931693

1694-
* Introduced in Nuclei SDK 0.5.1, worked with Nuclei Studio >= 2024.02
1694+
* **WARNING** GCC 14 with nuclei sdk code coverage not working, need to modify ``Components/profiling/gcov.c``, changes need to be made like this https://github.com/Nuclei-Software/nuclei-sdk/commit/5aaae0d5a7
1695+
* Introduced in Nuclei SDK 0.6.0, worked with Nuclei Studio >= 2024.02
16951696
* Using gprof or gcov introduces instrument code into the original program,
16961697
necessitating additional memory to store the collected data. This results in
16971698
a slight increase in the program's memory footprint compared to its uninstrumented counterpart.
16981699
* It cannot be directly used in command line mode, you should use it in Nuclei Studio.
16991700
* Please check ``README.md`` about gcov and gprof support in https://github.com/Nuclei-Software/nuclei-sdk/tree/master/Components/profiling
17001701

1701-
Import or download Nuclei SDK 0.5.1 or later release NPK in Nuclei Studio, and then create a
1702+
Import or download Nuclei SDK 0.6.0 or later release NPK in Nuclei Studio, and then create a
17021703
project called ``demo_profiling`` based on ``app-nsdk_demo_profiling`` using
17031704
``Create Nuclei RISC-V C/C++ Project`` Wizard as below:
17041705

@@ -1712,6 +1713,7 @@ it is the core algorithm of this example, then you just need to do the following
17121713

17131714
- Right click on the ``application`` folder, and click ``Properities``, and add extra options
17141715
in ``C/C++ Build`` -> ``Settings`` -> ``GNU RISC-V Cross C Compiler`` -> ``Miscellaneous`` -> ``Other compiler flags``.
1716+
17151717
- If you want to do gprof, you need to add ``-pg`` option.
17161718
- If you want to do gcov, you need to add ``-coverage`` option.
17171719
- Open ``main.c``, and find ``TODO`` item, and comment ``gprof_collect(2);`` or ``gcov_collect(2);`` based on

doc/source/quickstart.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ We need to build application for this board :ref:`design_board_gd32vf103v_rvstar
249249

250250
.. note::
251251

252-
* If you want to run on Nuclei Evaluation SoC, see :ref:`design_soc_evalsoc`, recommend to run :ref:`design_app_cpuinfo`
252+
* If you want to run on Nuclei Evaluation SoC, see :ref:`design_soc_evalsoc`, recommend to run :ref:`design_app_cpuinfo`
253253
* Since below steps are taking gd32vf103 SoC based board **gd32vf103v_rvstar** to do demostration,
254254
and when you pass ``SOC=gd32vf103``, the default BOARD will be ``gd32vf103v_rvstar``, so
255255
do you don't need to pass ``BOARD=gd32vf103v_rvstar``
@@ -599,7 +599,8 @@ For more advanced usage, please follow the items as below:
599599

600600
2. Now **Terapines ZCC Lite** is deeply integrated in **Nuclei Studio >= 2024.06**, so you just need to
601601
follow :ref:`quickstart_get_set_nuclei_sdk` to setup PATH for Terapines ZCC, and in Nuclei SDK,
602-
you can just pass **TOOCHAIN=terapines** during make to take a try with Terapines ZCC.
602+
you can just pass **TOOCHAIN=terapines** during make to take a try with Terapines ZCC, please use
603+
latest Terapines ZCC from its website https://www.terapines.com/.
603604
From 0.7.0 release, you can create project in Nuclei Studio >= 2024.06 using Terapines ZCC, see
604605
`Using Terapines ZCC Toolchain in Nuclei Studio`_.
605606

0 commit comments

Comments
 (0)