Differences

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

--- lkmp:lkmp_task_list [2019/10/16 19:21]
ShuahKhanLF
+++ lkmp:lkmp_task_list [2020/01/07 20:05] (current)
BjornHelgaas
@@ Line 3: / Line 3: @@
 ==== Documentation conversion and updates ====
-The following directories have several .txt file. Please pick 2 files and convert to ReST. There are a few exceptions that should be kept as plain text files.
+The following directories have several .txt files. Please pick two files and convert to ReST. There are a few exceptions that should be kept as plain text files:
   * a configuration file whose extension is .txt;
-  * a dump of chapter extracted from an old arch-specific manual with seems to be provided by its manufacturer.
+  * a dump of chapter extracted from an old arch-specific manual which seems to be provided by its manufacturer.
 **Preparing to build the documentation:**
-There's a script with checks if you have all needed dependencies to build the documentation. It is called automatically when you run ''make htmldocs''. Alternatively, you can call the script directly with:
+There's a script that checks if you have all needed dependencies to build the documentation. It is called automatically when you run ''make htmldocs''. Alternatively, you can call the script directly with:
 <code>
@@ Line 16: / Line 16: @@
 </code>
-**Building docs and looking for warns:**
+**Building docs and looking for warnings:**
 Once you have all the requirements, you can do the building with:
@@ Line 113: / Line 113: @@
 | Documentation/gpu/drm-internals.rst | Fix warns | | | |
-==== Cleanup cppcheck errors ====
-**Shifting signed 32-bit value by 31 bits is undefined behaviour errors**
-These errors aren't real problems for us as compiler takes care of these. However, cleaning these up doesn't hurt, especially in public API headers. Some maintainers might like drivers fixed, on the other hand fixing public API headers first is a good idea. There are two ways to fix this:
-  * Change #define FOO    (1 << 31) to #define FOO    BIT(31) or
-  * Adding a "U" cast - changing (1 << 31) to (1U << 31)
-cd git_repo_dir
-cppcheck --force ./ > cppcheck.out 2>&1
-You can run cppcheck on one or more files by passing a list of files:
-cppcheck --file-list=files
-Grep for "Shifting signed 32-bit value by 31 bits is undefined behaviour" errors
-You can refer to the one I generated on [[https://drive.google.com/file/d/19Xu7UqBGJ7BpzxEp92ZQYb6F8UPrk3z3/view?usp=sharing|Linux 5.2-rc3 cppcheck 32-bit log]]
-[[https://drive.google.com/file/d/1EbBsyLNh9nQuB_z4JbkyxDsXqItSpNo4/view?usp=sharing|Linux 5.2-rc3 cppcheck full log]]
-**Defines in public headers - include/**
-^   ^   ^
-| **File**  | **Define** | **Status** |
-**Uninitialized variable errors/warns**
-Grep for Uninitialized variable errors and send fixes in. Make sure the error is real and not a false. Check to see if it is used before initializing.

Wiki

User Tools

Site Tools

Differences

Page Tools