diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 7014b618e047416c60e54abf2a7f853efce90261..c2d61da2cd5bbd767fb503866d76fb2de6431ccc 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -84,10 +84,10 @@ build-documentation: - pip3 install requests - | if [ ${CI_COMMIT_BRANCH} == ${CI_DEFAULT_BRANCH} ]; then - ./documentation/rtdbuild.py --domain https://readthedocs.com --token ${READTHEDOCS_TOKEN} --project ${READTHEDOCS_PROJECT} --branch latest --state active + ./documentation/_scripts/rtdbuild.py --domain https://readthedocs.com --token ${READTHEDOCS_TOKEN} --project ${READTHEDOCS_PROJECT} --branch latest --state active else - ./documentation/rtdbuild.py --domain https://readthedocs.com --token ${READTHEDOCS_TOKEN} --project ${READTHEDOCS_PROJECT} --branch main --state inactive - ./documentation/rtdbuild.py --domain https://readthedocs.com --token ${READTHEDOCS_TOKEN} --project ${READTHEDOCS_PROJECT} --branch ${CI_COMMIT_BRANCH} --state inactive + ./documentation/_scripts/rtdbuild.py --domain https://readthedocs.com --token ${READTHEDOCS_TOKEN} --project ${READTHEDOCS_PROJECT} --branch main --state inactive + ./documentation/_scripts/rtdbuild.py --domain https://readthedocs.com --token ${READTHEDOCS_TOKEN} --project ${READTHEDOCS_PROJECT} --branch ${CI_COMMIT_BRANCH} --state inactive fi prep-test-assets: diff --git a/config/cca-4world.yaml b/config/cca-4world.yaml index cbdb64e76dfbd49a562f187f761dd9fa567e60f8..5949c6629f9e2d3bfe757ce12463f9c9d34b465f 100644 --- a/config/cca-4world.yaml +++ b/config/cca-4world.yaml @@ -23,7 +23,6 @@ description: >- .. code-block:: shell # cat /sys/devices/arm-ffa-*/uuid - b4b5671e-4a90-4fe1-b81f-fb13dae1dacb d1582309-f023-47b9-827c-4464f5578fc8 79b55c73-1d8c-44b9-8593-61e1770ad8d2 diff --git a/documentation/_scripts/genconfigstore.py b/documentation/_scripts/genconfigstore.py index e8e32b097e92059a3871b4d3a2ea85ed812f49f3..c9f91922febd9a92c9d01aa655e8575b7e102d5d 100755 --- a/documentation/_scripts/genconfigstore.py +++ b/documentation/_scripts/genconfigstore.py @@ -22,26 +22,39 @@ def make_rst_table(headers, data): colwidths.append(colwidth) def track_str(colwidths): - return ' '.join(['=' * w for w in colwidths]) + '\n' + return ' '.join(['=' * w for w in colwidths]) def row_str(colwidths, data): - return ' '.join([f'{d:{w}}' for d, w in zip(data, colwidths)]) + '\n' + return ' '.join([f'{d:{w}}' for d, w in zip(data, colwidths)]) - table = '' - table += track_str(colwidths) - table += row_str(colwidths, headers) - table += track_str(colwidths) + table = [] + table.append(track_str(colwidths)) + table.append(row_str(colwidths, headers)) + table.append(track_str(colwidths)) for row in data: - table += row_str(colwidths, row) - table += track_str(colwidths) + table.append(row_str(colwidths, row)) + table.append(track_str(colwidths)) - return table + table = [r.rstrip() for r in table] + return '\n'.join(table) + '\n' def make_rst_table_from_dict(headers, data): return make_rst_table(headers, [(k, v) for k, v in data.items()]) +def fix_whitespace(text): + lines = [] + for line in text.splitlines(): + line = line.rstrip() + if not line.startswith((' ', '\t')): + line += '\n' + lines.append(line) + if (len(lines)): + lines[-1] = lines[-1].rstrip() + return '\n'.join(lines) + + index = """.. # Copyright (c) 2023, Arm Limited. # @@ -113,7 +126,7 @@ with open(os.path.join(docsdir, 'index.rst'), 'w') as indexf: '#' * len(c['name']), c['name'], '#' * len(c['name']), - c['description'].replace('\n', '\n\n'), + fix_whitespace(c['description']), c['concrete'], make_rst_table_from_dict(('btvar', 'default'), c['btvars']), make_rst_table_from_dict(('rtvar', 'default'), c['rtvars'])) diff --git a/documentation/rtdbuild.py b/documentation/_scripts/rtdbuild.py similarity index 100% rename from documentation/rtdbuild.py rename to documentation/_scripts/rtdbuild.py diff --git a/documentation/userguide/configstore/bootwrapper.rst b/documentation/userguide/configstore/bootwrapper.rst index d17626b10931c6339dcbad1a35be2ecbbd820b96..a401f2f0d495ee1eebea191d03dd8f5f20044721 100644 --- a/documentation/userguide/configstore/bootwrapper.rst +++ b/documentation/userguide/configstore/bootwrapper.rst @@ -33,8 +33,8 @@ Run-Time Variables ============== ======= rtvar default ============== ======= -LOCAL_NET_PORT 8022 -BOOTWRAPPER +LOCAL_NET_PORT 8022 +BOOTWRAPPER ROOTFS ============== ======= diff --git a/documentation/userguide/configstore/ffa-tftf.rst b/documentation/userguide/configstore/ffa-tftf.rst index d377cb63a7d0c39dd59d69187941714a71dcd103..308f74be28febe8b541c7a8d089dfd23f999cdc1 100644 --- a/documentation/userguide/configstore/ffa-tftf.rst +++ b/documentation/userguide/configstore/ffa-tftf.rst @@ -29,16 +29,16 @@ Run-Time Variables ################## ============== =============================================================== -rtvar default +rtvar default ============== =============================================================== -LOCAL_NET_PORT 8022 -BL1 ${artifact:BL1} -FIP ${artifact:FIP} -DTB ${artifact:DTB} +LOCAL_NET_PORT 8022 +BL1 ${artifact:BL1} +FIP ${artifact:FIP} +DTB ${artifact:DTB} CMDLINE console=ttyAMA0 earlycon=pl011,0x1c090000 root=/dev/vda ip=dhcp -KERNEL -ROOTFS -SHARE -EDK2FLASH ${artifact:EDK2FLASH} +KERNEL +ROOTFS +SHARE +EDK2FLASH ${artifact:EDK2FLASH} ============== =============================================================== diff --git a/documentation/userguide/configstore/index.rst b/documentation/userguide/configstore/index.rst index 252dc9d12527f03bd8d665c858301cf7fddba9f5..c7c0f41eedcd03243afb4b8301814ab0c72e8e00 100644 --- a/documentation/userguide/configstore/index.rst +++ b/documentation/userguide/configstore/index.rst @@ -19,5 +19,6 @@ out-of-the-box: cca-3world.rst cca-4world.rst ffa-tftf.rst + ns-edk2-optee.rst ns-edk2.rst ns-preload.rst diff --git a/documentation/userguide/configstore/ns-edk2-optee.rst b/documentation/userguide/configstore/ns-edk2-optee.rst new file mode 100644 index 0000000000000000000000000000000000000000..e38875126c11443ca72bb83b9a22538862b83931 --- /dev/null +++ b/documentation/userguide/configstore/ns-edk2-optee.rst @@ -0,0 +1,44 @@ +.. + # Copyright (c) 2023, Arm Limited. + # + # SPDX-License-Identifier: MIT + +################## +ns-edk2-optee.yaml +################## + +Description +########### + +Brings together a software stack to demonstrate OPTEE in secure EL1 with TF-A in secure EL3 but without FF-A and secure EL2(Hafnium). Secure partition dispatcher exists inside OPTEE. + +Concrete +######## + +True + +Build-Time Variables +#################### + +===== ======= +btvar default +===== ======= +===== ======= + +Run-Time Variables +################## + +============== =============================================================== +rtvar default +============== =============================================================== +LOCAL_NET_PORT 8022 +BL1 ${artifact:BL1} +FIP ${artifact:FIP} +DTB ${artifact:DTB} +CMDLINE console=ttyAMA0 earlycon=pl011,0x1c090000 root=/dev/vda ip=dhcp +KERNEL +ROOTFS +SHARE +EDK2FLASH ${artifact:EDK2FLASH} +============== =============================================================== +