blob: 065ebe32876784fd5917bb32a615bf50a25bba38 [file] [log] [blame]
Karl Zhang3de5ab12021-05-31 11:45:48 +08001#####################
2'lib'-directory guide
3#####################
4
5************
6Introduction
7************
8
9This directory contains the customizable "boilerplate" code snippets used to
10write out C source code. The file in this directory currently, is that for
11TF-M, but other comparable frameworks could be addressed with equivalent files
Nik Dewallybc9e1942024-07-02 17:00:15 +010012tailored for the required syntax of that other framework.
Karl Zhang3de5ab12021-05-31 11:45:48 +080013
14Which file to use for this process is selected by setting two environment
15variables pointing to that file: One for the ``lib`` directory and one for the
16file itself within that directory. In ``bash`` syntax,
17
18.. code-block:: bash
19
20 export TF_FUZZ_LIB_DIR=<path to this TF-M installation>/tools/tf_fuzz/lib
21 export TF_FUZZ_BPLATE=tfm_boilerplate.txt
22
23
Nik Dewallybc9e1942024-07-02 17:00:15 +010024**********************************
25``tf_fuzz/lib`` directory contents
26**********************************
Karl Zhang3de5ab12021-05-31 11:45:48 +080027.. code-block:: bash
28
29 tfm_boilerplate.txt
30
31--------------
32
33*Copyright (c) 2020, Arm Limited. All rights reserved.*