aboutsummaryrefslogtreecommitdiff
path: root/docs/contributing
AgeCommit message (Collapse)Author
3 daysPlatform: Alcor: Add armchina alcor an557 platform portJidongMei
Change-Id: I310c27a97dca165c0151b680fca0f7db19bcc338 Signed-off-by: JidongMei <Jidong.Mei@armchina.com>
11 daysDocs: Update the list of MaintainersAnton Komlev
and sort it alphabetically. Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I99aeebd57db78e8cbad141c01834b20ecd4f261d
2024-03-08docs: Add MPS4 as maintained platformDávid Házi
Signed-off-by: Dávid Házi <david.hazi@arm.com> Change-Id: I99b441f3273a66cee75bb92f77953f1d6e55f861
2024-01-11Docs: Update Documentation GuidelinesElena Uziunaite
Change-Id: Iefd28d7af53d23bf27615e63e760327bf570a947 Signed-off-by: Elena Uziunaite <elena.uziunaite@arm.com>
2023-12-18docs: Update Nordic maintainerGeorgios Vasilakis
Update the Nordic maintainer since Joakim is not employed by Nordic anymore. Signed-off-by: Georgios Vasilakis <georgios.vasilakis@nordicsemi.no> Change-Id: Ie9e25bdc1d40663844caa9b25bf6f47607e5b351
2023-12-12Docs: Rename RSS to RSEJamie Fox
Renames Runtime Security Subsytem (RSS) to Runtime Security Engine (RSE) in the docs. This patch does not affect paths or code. Signed-off-by: Jamie Fox <jamie.fox@arm.com> Change-Id: Iecf170beef5ea694bd8eb682b877370a5eacda05
2023-12-07Docs: Typo FixElena Uziunaite
Change-Id: I0fe7201b141e19a407396a9f7be6260625bdaa88 Signed-off-by: Elena Uziunaite <elena.uziunaite@arm.com>
2023-07-26Docs: Add topic for interface changesKen Liu
As there is no proper topic for interface changes now. Signed-off-by: Ken Liu <Ken.Liu@arm.com> Change-Id: Ia9f27b954f24e9da6a0c8d94f6e1ac888784148f
2023-05-31Docs: Update contribution guide for multiple changesAnton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: Ifc9cae45de1dbda95fb0d3a23fd4088aac73fc02
2023-04-30Merge remote-tracking branch 'origin/release/1.8.x' into origin/masterAntonio de Angelis
Signed-off-by: Antonio de Angelis <antonio.deangelis@arm.com> Change-Id: Iee3d063bf6d78f1f3fa0cb26b19a3bfa8d4ef939
2023-04-27Docs: Fix NXP platform owner e-mailAndrej Butok
Fix NXP platform owner e-mail typo Signed-off-by: Andrej Butok <andrey.butok@nxp.com> Change-Id: I9dcaa50ee2628207821648141a2b2ec534502c28
2023-04-25SPM: Merge 'ffm' and 'cmsis_psa' sourcesKen Liu
The library model referenced CMSIS sources hence its adaptation layer name was 'cmsis_func' - and then this style was applied to the IPC model and brought in an IPC adaptation layer with the name 'cmsis_psa'. And folder 'ffm' contains the common logic. Now the library model is deprecated so 'cmsis_psa' is the only adaptation layer left. As far of now, there are no obvious requirements about referencing the common logic or the adaptation layer individually, so let's merge common logic and the adaptation sources into one folder 'core', and keep the folders containing extended functionalities (Non-secure clients identification e.g.) at the same level as 'core' with a suffix 'ext' in the folder name. Signed-off-by: Ken Liu <Ken.Liu@arm.com> Change-Id: Ibfd753879c60aff9adbf400b9f35c9c66de86eb9 Co-authored-by: Xinyu Zhang <xinyu.zhang@arm.com>
2023-04-19 Docs: update maintainers list for Corstone1000 platformEmekcan Aras
Signed-off-by: Emekcan Aras <emekcan.aras@arm.com> Change-Id: I351256ddf79782c3003f9823f1e7b9384aabd215
2023-03-13Docs: Fix broken links in documentation filesAwadhy Mohammed
Signed-off-by: Awadhy Mohammed <awadhy.mohammed@arm.com> Change-Id: I29906e6e212f285fc33825689a349fd790ddddea
2023-03-06Docs: Documentation update. Copyright, licensing.Anton Komlev
- Add Copyright placement guidance - Clarify licencing information - Remove a small typo Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I4c7cd0dd5607d6e60f6d7f1e87adefcc20006ba0
2023-02-14Docs: Adding David Hazi as new maintainerMark Horvath
Signed-off-by: Mark Horvath <mark.horvath@arm.com> Change-Id: I418526d9c7873064fbd84211e64f15d83d86f489
2023-02-10Docs: Update code structure docAnton Komlev
- fix the number of CPU to 8 to avoid Sphinx crash in OpenCI Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I4f05857a639ec2609f5b21cb739a6e91e5372fc0
2023-02-09Docs: Platform documentation rulesAnton Komlev
- Minimal rules for a platform documentation - Adjust existing platforms according to the rules Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: Idcb85f8ed5d55aa6406cd48cdfcb558d92ff0647
2023-02-09Docs: Move the design documents a level upAnton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: Ib366994121b7c57c5f4966499c2364f339d11b05
2022-10-21Audit: Remove Audit Log partitionSummer Qin
Audit Log partition is only supported in Library Model. With Library Model is deprecated, Audit Log partition is removed too. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: Ib45b0ee92e34635f62c22288ffe8a8ca70e0b41b
2022-08-24Docs: update maintainers list for Corstone1000 platformMohamed Omar Asaker
Signed-off-by: Mohamed Omar Asaker <mohamed.omarasaker@arm.com> Change-Id: I703fb45651e0f6f2f252f6cb1d2246efcb3c9309
2022-08-15Docs: Extend CPL limit in coding rulesAnton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: If6d9507773eca9b2e5f40bb9f614a7154c421f62
2022-08-15Docs: A bunch of small fixesAnton Komlev
- remove "Migration from legacy buildsystem" as obsolete - update the list of topics in Contribution guide - update broken links in the Glossary - add a link to TF-M forum in introduction - update "Code Sharing" guide - change warning of usage the default keys - update mbedTLS repository URL Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I8a2fa1802fddfa0a098f3999c0fffb5d0d003d06
2022-07-26Docs: Add code owners for RSS and BL1Jamie Fox
Change-Id: Ic9e8d38a9e57d5441cab4c73b5901e7da7d4f8ee Signed-off-by: Jamie Fox <jamie.fox@arm.com>
2022-07-26Docs: update maintainer list for arm platformsSatish Kumar
Change-Id: I59069bcb9b3e916154814dff65927be6bbab8c86 Signed-off-by: Satish Kumar <satish.kumar01@arm.com>
2022-07-04Docs: Restructure in the Platfoms sectionAnton Komlev
- Move platforms' documentaions from /ext/target/ to the /platform folder - Name arm platforms in TOC explicitly. - Merge CS-1000 platform README with Openamp doc - Rebase and include RSS platform Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: If8bc343e92910e2ce94f1fe1d6c8c81802d63165
2022-07-04Docs: Rearrange TF-M building instructionsAnton Komlev
- move the building instructios to a dedicated folder, reflecting main TOC - adjust links in the documentation Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I335de95061938d619a47cd813020121809e1459b
2022-06-15Docs: Remove Ray Ngun as Cypress maintainerChris Brand
Ray is no longer with Cypress. Change-Id: Ie3b44ee708bbe6f60bd40453205decaf8adc8f76 Signed-off-by: Chris Brand <chris.brand@cypress.com>
2022-06-14Docs: Refine the contribution processDavid Hu
- Remove the bullets of Phabricator which is rarely used now. - Update the design proposal description. Clarify the process accordingly. - Refer to Gerrit offical documents for gerrit operation details instead of making simplifed descriptions. Change-Id: I8706e019f95c0e528ff34c2ada856d14bd98aeab Signed-off-by: David Hu <david.hu@arm.com>
2022-06-10Docs: Maintainer: Change Laird Connectivity platform ownerJamie McCrae
This replaces myself with Greg Leach to maintain the Laird Connectivity Platforms in TF-M. Signed-off-by: Jamie McCrae <jamie.mccrae@lairdconnect.com> Change-Id: I80586c1c2fd26a5ff6d635f1776aaa312b0213fa
2022-05-13SPRT: Rename the folder name to 'runtime'Ken Liu
The original name 'sprt' can be confusing if user did not read SPRTL related document, hence rename it as 'runtime' to indicate it is a secure partition runtime API set. Signed-off-by: Ken Liu <Ken.Liu@arm.com> Change-Id: I3ba7d5e80dd2ee32d52463bcdf012a2f5bf6017c
2022-04-27Docs: Update broken URLsAnton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I9649113504e174d0f1e8d2b59eb731d0d26c87f6
2022-04-23docs: Documentation restructureTF-Mv1.6.0-RC4Anton Komlev
- Change main index structure - Sort out integration and porting guidelines - Resort table with releases - Add Tools section. To be adjusted further for tf-m-tools Intention to minimise files movement to simplify review process. Affected files shall be moved later after the new structure agreement. Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I0352bebabe09d4f7b5e8848ee620c0cea6881c94
2022-04-23docs: Direct documentation buildAnton Komlev
- Stop prebuilding conf.py and passing environmental info there - Simplify CMake script for Shpinx doc generation - Enable true incremental build for *.rst files Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I0c49043cda43dca263f530dde13052bcf9f49046
2022-04-23docs: Decouple refrences from /docs folderAnton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I1955201382074eb9e6dd80aadbc456eb09aecb22
2022-03-09Docs: Deprecate previous design proposal processDavid Hu
Replace previous design proposal process with the new design proposal guideline. Remove the document. Update contributing process document. Change-Id: Ia31dbe2dad6c91bb6821c456e3929b9dd1b18d04 Signed-off-by: David Hu <david.hu@arm.com>
2022-03-09Docs: Propose a new design proposal guidelineDavid Hu
Propose a new design proposal guideline to simplify the design proposal process. The background section will be removed after the new guideline is accepted. Change-Id: Id7c060bed28c2c385dab15c15a2dc0a8305e5bef Signed-off-by: David Hu <david.hu@arm.com>
2022-02-22readme: Add Joakim as a Nordic maintainerSebastian Bøe
Add Joakim Andersson as a new Nordic maintainer and remove the rest of the Nordic maintainers. Sebastian will be taking a sabbatical and Joakim will be taking over. Change-Id: I7306caa38476ff1a67c918ddb9e5780e25cebd48 Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
2021-11-03docs: Code owners updateAnton Komlev
Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: Ic0a0742f385a27a43174011d1daf086d569ca7ab
2021-10-21docs: Update document headersAnton Komlev
- Remove the outdated :Status: field, being confusing. - Change :Authors: to :Author: where appropriate Signed-off-by: Anton Komlev <anton.komlev@arm.com> Change-Id: I7aa33778ac4794a8360abaafdc0e98519478c6f0
2021-09-07readme: Add Sebastian as a Nordic maintainerSebastian Bøe
Add Sebastian Bøe as a new Nordic maintainer. Change-Id: I7306caa38476ff1a67c918ddb9e5780e25cebd38 Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
2021-07-13Docs: Move design documents into a dedicated folderDavid Hu
Collect all the design documents under a dedicated design_docs folder. Update the links in other documents. Change-Id: I2da761a11317144185e960c539f2245d3d46fd2a Signed-off-by: David Hu <david.hu@arm.com>
2021-06-23Docs: Refine tfm_sw_requirement.rstSummer Qin
Simplify the tfm software requirement document and change the document to 'tfm_getting_started.rst', let it more suitable for new starter. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I10379aa92ac2c6cd784f0fd1b1b5431243716d74
2021-06-17Docs: Move build instruction and user guide into technical referenceSummer Qin
Move build instruction document and user guide document from getting started into technical references folder. Rename 'tfm_user_guide.rst' to 'tfm_run_instruction.rst'. This will make the document structure more clear for readers. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I69d46151f2cb97c828c1b82775ffd1af9032ed45
2021-04-29Platform: Add support for BL5340 DVKJamie McCrae
This adds supports for the Laird Connectivity BL5340 DVK (development kit) application core, which is based on the nRF5340 SoC. Signed-off-by: Jamie McCrae <jamie.mccrae@lairdconnect.com> Change-Id: I062412918d4cbe692748c1a31fef444190f50661
2021-04-21Docs: Restructure the documentsSummer Qin
Restructure the file category to let it more friendly to users. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I7ced0e2d700ce03423e472e0098608f3445ba169
2021-03-30Update maintainers fileChris Brand
Add Infineon company name (Cypress is now owned by Infineon). Add Chris Brand, Ken Liu, David Hu as new miantainers. Remove Abhishek Pandit, Ashutosh Singh, Miklos Balint from mainteiners. Change-Id: Iddac1b24d455f55aec01bdde6857cf4b18233fca Signed-off-by: Chris Brand <chris.brand@cypress.com> Signed-off-by: Anton Komlev <anton.komlev@arm.com>
2021-03-17platform: Add deprecation warnings for nRF5340 PDKAndrzej Głąbek
Indicate that the nRF5340 PDK (nordic_nrf/nrf5340pdk_nrf5340_cpuapp) platform is deprecated by issuing a corresponding cmake warning at build time and a run-time log message when the platform is initialized. Add also the platform to the List of Deprecated Platforms in the Platform deprecation and removal section of the TF-M documentation. Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no> Change-Id: Ibe657cf03d8973703418ac260a8d20d7fa1a85d7
2021-03-11Revert "Platform: Remove Musca_A platform code (Deprecation)"Anton Komlev
This reverts commit a29d6695749aedb4015320af18e782b85744600a. Reason for revert: Musca-A is still a reference platform for 1 user. Change-Id: I3a96d5157677390360aaa82eac96b9810db58c43
2021-03-11Platform: Remove Musca_A platform code (Deprecation)Minos Galanakis
This patch removes Musca A board from platform code-base and documentation. Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Change-Id: I613eac2b478655b6b6f8195339b2502f1c5a79b9