Differences

This shows you the differences between two versions of the page.

--- en:users:drivers:ath10k:codingstyle [2015/11/06 10:27]
Mohammed Shafi Shajakhan
+++ en:users:drivers:ath10k:codingstyle [2018/04/12 13:37]
Kalle Valo Move Linux coding style and checking code sections to the beginning of the page
@@ Line 7: / Line 7: @@
 ===== ath10k Coding Style =====
+==== Linux coding style ====
+ath10k mostly follows [[https://www.kernel.org/doc/html/latest/process/coding-style.html|Linux Coding Style]], so read that first.
+==== 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:
+<code>
+~$ cd ~/ath
+~/ath$ ls
+arch/    debian/         include/  lib/                               Module.symvers  sound/
+block/   Documentation/  init/     localversion-wireless-testing      net/            tools/
+certs/   drivers/        ipc/      localversion-wireless-testing-ath  README          usr/
+COPYING  firmware/       Kbuild    MAINTAINERS                        samples/        virt/
+CREDITS  fs/             Kconfig   Makefile                           scripts/        vmlinux-gdb.py@
+crypto/  GNUmakefile     kernel/   mm/                                security/
+~/ath$ ath10k-check
+drivers/net/wireless/ath/ath10k/debug.h:207: return is not a function, parentheses are not required
+drivers/net/wireless/ath/ath10k/debug.h:209: return is not a function, parentheses are not required
+drivers/net/wireless/ath/ath10k/debug.h:210: return is not a function, parentheses are not required
+drivers/net/wireless/ath/ath10k/debug.h:214: Alignment should match open parenthesis
+drivers/net/wireless/ath/ath10k/debug.h:218: Alignment should match open parenthesis
+drivers/net/wireless/ath/ath10k/debug.c:2430: code indent should use tabs where possible
+drivers/net/wireless/ath/ath10k/debug.c:2430: please, no spaces at the start of a line
+drivers/net/wireless/ath/ath10k/debug.c:2431: code indent should use tabs where possible
+drivers/net/wireless/ath/ath10k/debug.c:2431: please, no spaces at the start of a line
+drivers/net/wireless/ath/ath10k/debug.c:2464: code indent should use tabs where possible
+drivers/net/wireless/ath/ath10k/debug.c:2464: please, no spaces at the start of a line
+drivers/net/wireless/ath/ath10k/debug.c:2465: code indent should use tabs where possible
+drivers/net/wireless/ath/ath10k/debug.c:2465: please, no spaces at the start of a line
+drivers/net/wireless/ath/ath10k/debug.c:2493: Please don't use multiple blank lines
+drivers/net/wireless/ath/ath10k/debug.c:2525: Symbolic permissions 'S_IRUSR' are not preferred. Consider using octal permissions '0400'.
+drivers/net/wireless/ath/ath10k/debug.c:2527: Symbolic permissions 'S_IRUSR' are not preferred. Consider using octal permissions '0400'.
+drivers/net/wireless/ath/ath10k/debug.c:2620: Alignment should match open parenthesis
+drivers/net/wireless/ath/ath10k/debug.c:2640: Alignment should match open parenthesis
+~/ath$
+</code>
 ==== Status/error variables ====
@@ Line 113: / Line 152: @@
 Don't use typedef.
-==== Linux style ====
-Follow [[http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob;f=Documentation/CodingStyle;hb=HEAD|Linux Coding Style]].
-==== Checking code ====
-Run sparse:
-<code>make drivers/net/wireless/ath/ath10k/ C=2 CF="-D__CHECK_ENDIAN__"</code>

Linux Wireless

User Tools

Site Tools

Differences

Page Tools