en:users:drivers:ath10k:codingstyle
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
en:users:drivers:ath10k:codingstyle [2024/04/30 05:40] Kalle Valo Write about tools, mention ath11k and ath12k |
en:users:drivers:ath10k:codingstyle [2024/04/30 05:50] Kalle Valo [Checking code] add links to ath11k-check and ath12k-check |
||
|---|---|---|---|
| Line 13: | Line 13: | ||
| ==== Tools ===== | ==== Tools ===== | ||
| - | Use latest GCC which you can download from [[https://mirrors.edge.kernel.org/pub/tools/crosstool/|crosstool]]. Setting it up is easy, unpack it to a directory and create a GNUmakefile: | + | Use latest GCC which you can download from [[https://mirrors.edge.kernel.org/pub/tools/crosstool/|crosstool]]. Setting it up is easy, unpack it to a directory and create a GNUmakefile in Linux sources top-level directory: |
| <code> | <code> | ||
| Line 27: | Line 27: | ||
| ==== Checking code ==== | ==== Checking code ==== | ||
| - | For checking the code we have a dedicated script [[https://github.com/qca/qca-swiss-army-knife/blob/master/tools/scripts/ath10k/ath10k-check|ath10k-check]] which runs various tests, including sparse and checkpatch. Run the script with ''--help'' to see the installation and usage instructions. Strongly recommended to run this before submitting patches as it can catch common problems. Example: | + | For checking the code we have dedicated scripts for each driver: |
| + | |||
| + | * [[https://github.com/qca/qca-swiss-army-knife/blob/master/tools/scripts/ath10k/ath10k-check|ath10k-check]] | ||
| + | * [[https://github.com/qca/qca-swiss-army-knife/blob/master/tools/scripts/ath11k/ath11k-check|ath11k-check]] | ||
| + | * [[https://github.com/qca/qca-swiss-army-knife/blob/master/tools/scripts/ath12k/ath12k-check|ath12k-check]] | ||
| + | |||
| + | They run various tests, including sparse and checkpatch. Run the script with ''--help'' to see the installation and usage instructions. ''--version'' shows version information for all dependencies, include that when reporting a problem. | ||
| + | |||
| + | It is required to run the check script before submitting patches as it can catch common problems. There must not be any warnings! | ||
| + | |||
| + | An example how to run the script: | ||
| <code> | <code> | ||
en/users/drivers/ath10k/codingstyle.txt · Last modified: 2024/05/05 04:24 by Kalle Valo
Page Tools
