RIOT icon indicating copy to clipboard operation
RIOT copied to clipboard

Update creating-modules.md

Open Wunderbaeumchen99817 opened this issue 1 year ago • 4 comments

Contribution description Adds example based documentation about adding glue code for existing modules

Issues/PRs references N/A

Wunderbaeumchen99817 avatar May 27 '24 13:05 Wunderbaeumchen99817

Thanks for the write-up! Since this mostly concerns the PSA Crypto API, I would rather expect as part of its documentation.

Actually, there is already a porting guide for both software and hardware backends present: https://doc.riot-os.org/group__sys__psa__crypto.html#porting-guide Would you mind comparing that information to your findings and potentially enhancing that one instead? You can find the source code in https://github.com/RIOT-OS/RIOT/blob/master/sys/psa_crypto/doc.txt

mguetschow avatar May 28 '24 08:05 mguetschow

Thanks for the changes. However, there is already some documentation on adding glue code in that same file. Could you maybe compare the existing documentation with your workflow and make changes where necessary instead of adding a new section?

(Also I think you might have wanted to edit the PR description of another PR of yours instead :P)

mguetschow avatar Jun 03 '24 09:06 mguetschow

Murdock results

:heavy_check_mark: PASSED

234ed59c981f6a7362d783c58669a9b1337f2eec Update doc.txt

Success Failures Total Runtime
1 0 1 01m:12s

Artifacts

riot-ci avatar Jun 04 '24 10:06 riot-ci

@Wunderbaeumchen99817 would you mind updating this PR so we can have it in the next release?

mguetschow avatar Jul 09 '24 08:07 mguetschow

Closing this as stale.

mguetschow avatar Oct 29 '24 19:10 mguetschow