diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/project-ideas.md | 52 | ||||
| -rw-r--r-- | Documentation/sparse.txt | 2 | ||||
| -rw-r--r-- | Documentation/submitting-patches.md | 21 |
3 files changed, 74 insertions, 1 deletions
diff --git a/Documentation/project-ideas.md b/Documentation/project-ideas.md new file mode 100644 index 00000000..380f850b --- /dev/null +++ b/Documentation/project-ideas.md @@ -0,0 +1,52 @@ +Why hacking on sparse +===================== + +1. sparse is small. + The full project compiles in less than 10 seconds on old and not performing laptop. +2. sparse is fast. + Typically, sparse can check a C file 1/10 of time it takes for gcc to generate object files. +3. sparse can digest the full kernel source files. + With sparse-llvm, sparse uses llvm as back end to emit real machine code. + +New developer hacking on sparse +============================== + + +* All sparse warning messages should include the option how + to disable it. + e.g. "pre-process.c:20*:28: warning: Variable length array is used." + should be something like + "pre-process.c:20*:28: warning: Variable length array is +used. (-Wno-vla)" +* extend test-inspect to inspect more AST fields. +* extend test-inspect to inspect instructions. +* adding architecture handling in sparse similar to cgcc +* parallel processing of test-suite +* Howto: fix the kernel rcu related checker warnings +* option to disable AST level inline. +* debug: debug version of sparse do all the verification double check +* test suite: verify and compare IR (suggested by Dibyendu Majumdar) +* checker error output database + +For experienced developers +========================== + +* merge C type on incremental declare of C type and function prototype. +* move attribute out of ctype to allow easier to add new attribute. +* serialize, general object walking driven by data structures. +* serialize, write sparse byte code into file +* serialize, load sparse byte code from file. +* symbol index/linker, know which symbol in which byte code file. +* inline function in instruction level +* cross function checking +* debug: optimization step by step log +* debug: fancy animation of CFG +* phi node location (Luc has patch) +* revisit crazy programmer warning, invalid SSA form. +* ptrlist, looping while modify inside the loop. +* dead code elimination using ssa +* constant propagation using ssa. +* x86/arm back end instruction set define +* register allocation. +* emit x86/arm machine level code + diff --git a/Documentation/sparse.txt b/Documentation/sparse.txt index 061791eb..383376c0 100644 --- a/Documentation/sparse.txt +++ b/Documentation/sparse.txt @@ -42,4 +42,4 @@ Reference: * Linus' e-mail about __nocast vs __bitwise: - http://article.gmane.org/gmane.linux.kernel.mm/75784 + http://marc.info/?l=linux-mm&m=133245421127324&w=2 diff --git a/Documentation/submitting-patches.md b/Documentation/submitting-patches.md new file mode 100644 index 00000000..fb176ce5 --- /dev/null +++ b/Documentation/submitting-patches.md @@ -0,0 +1,21 @@ +Submitting patches: the sparse version +====================================== + +Sparse uses a patch submit process similar to the Linux Kernel +[Submitting Patches](https://www.kernel.org/doc/html/v4.12/process/submitting-patches.html) + +This document mostly focuses on the parts that might be different from the Linux +Kernel submitting process. + +1. Git clone a sparse repository: + + git clone git://git.kernel.org/pub/scm/devel/sparse/sparse.git + +2. [Coding Style](https://www.kernel.org/doc/html/v4.12/process/coding-style.html) remains the same. + +3. Sign off the patch. + + The usage of the Signed-off-by tag is the same as [Linux Kernel Sign your work](https://www.kernel.org/doc/html/v4.12/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin). + + Notice that sparse uses the MIT License. + |