This is an old revision of the document!
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.
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:
./scripts/sphinx-pre-install
Building docs and looking for warns:
Once you have all the requirements, you can do the building with:
make htmldocs > doc_make.log 2>&1
And check the warnings with:
grep warn doc_make.log
Directory/File | Description | Status |
Documentation/scsi/*.txt | Convert to ReST | Open |
Documentation/RCU/*.txt | Convert to ReST | Open |
Backup tasks if the above get done. These directories also have a mix of .txt and .rst. The .txt files need to be converted to ReST.
Documentation/sh | Convert to ReST | Open |
Documentation/trace | Convert to ReST | Open |
Documentation/misc-devices | Convert to ReST | Open |
Documentation/virtual | Convert to ReST | Open |
Documentation/cpu-freq | Convert to ReST | Obsolete |
Documentation/admin-guide | Convert to ReST | Open |
Documentation/translations | Convert to ReST | Open |
Documentation/PCI | Convert to ReST | Open |
Documentation/filesystems | Convert to ReST | Open |
Documentation/networking | Convert to ReST | Open |
Documentation/netlabel | Convert to ReST | Open |
Documentation/crypto | Convert to ReST | Open |
Documentation/sparc | Convert to ReST | Open |
The following directories have files no extensions. These could be text files that need to be converted to ReST.
Documentation/misc-devices | Convert to ReST | Open |
Documentation/firmware_class | Convert to ReST | Open |
Documentation/isdn | Convert to ReST | Open |
Documentation/parisc | Convert to ReST | Open |
Documentation/spi | Convert to ReST | Open |
Documentation/scsi | Convert to ReST | Open |
Documentation/hwmon | Convert to ReST | Open |
Documentation/EDID | Move to some other place? | Open |
Documentation/nios2 | Convert to ReST | Open |
Documentation/virtual | Convert to ReST | Open |
Documentation/i2c | Convert to ReST | Open |
Documentation/usb | Convert to ReST | Open |
Documentation/translations | Convert to ReST | Open |
Documentation/openrisc | Convert to ReST | Open |
Documentation/w1 | Convert to ReST | Open |
Documentation/filesystems | Convert to ReST | Open |
Documentation/networking | Convert to ReST | Open |
Documentation/auxdisplay | Convert to ReST | Open |
When doing the conversion, it should be considered that the file should be easy to read/edit as a plain text file, yet producing a nice output for html (and pdf).
Callers of hrtimer_forward_now() should save the return value in u64. A few callers don't. Fix them.
Name | Description | File | Status |
cx88_ir_work() | missed is unsigned long | drivers/media/pci/cx88/cx88-input.c | Open |
rtc_pie_update_irq() | count is int | drivers/rtc/interface.c | Open |
sched_cfs_period_timer() | overrun is int | kernel/sched/fair.c | Open |
sched_rt_period_timer() | overrun is int | kernel/sched/rt.c | Open |
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:
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 Linux 5.2-rc3 cppcheck 32-bit log
Linux 5.2-rc3 cppcheck full log
Defines in public headers - include/
File | Define | Status |
uapi/linux/cramfs_fs.h | CRAMFS_BLK_FLAG_UNCOMPRESSED | Open |
uapi/linux/ethtool.h | RXH_DISCARD | Open |
uapi/linux/if_packet.h | TP_STATUS_TS_RAW_HARDWARE | Open |
uapi/linux/kfd_ioctl.h | KFD_IOC_ALLOC_MEM_FLAGS_WRITABLE | Open |
uapi/linux/media.h | MEDIA_ID_FLAG_NEXT | Patch Sent - use as reference |
uapi/linux/nl80211.h | NL80211_FEATURE_ND_RANDOM_MAC_ADDR | Open |
uapi/linux/vfio.h | VFIO_REGION_TYPE_PCI_VENDOR_TYPE | Open |
linux/videodev2.h | v4l2_fourcc_be | Patch sent - use as reference |
uapi/drm/exynos_drm.h | G2D_BUF_USERPTR | Open |
uapi/rdma/vmw_pvrdma-abi.h | PVRDMA_UAR_QP_RECV | Open |
uapi/rdma/vmw_pvrdma-abi.h | PVRDMA_UAR_CQ_POLL | Open |
linux/ata.h | ATA_PRD_EOT | Open |
linux/cs5535.h | CS5536_GPIOM7_PME_FLAG | Open |
linux/cs5535.h | CS5536_GPIOM7_PME_EN | Open |
linux/ide.h | IDE_DFLAG_NIEN_QUIRK | Open |
linux/ide.h | IDE_HFLAG_NO_UNMASK_IRQS | Open |
linux/pxa2xx_ssp.h | SSCR0_MOD | Open |
linux/pxa2xx_ssp.h | SSCR1_TTELP | Open |
linux/rtsx_pci.h | TRIG_DMA | Open |
linux/rtsx_pci.h | HAIMR_TRANS_START | Open |
linux/rtsx_pci.h | CMD_DONE_INT | Open |
linux/rtsx_pci.h | CMD_DONE_INT_EN | Open |
linux/serial_core.h | UPF_IOREMAP | Open |
media/dvb_frontend.h | DVBFE_ALGO_RECOVERY | Open |
media/dvb_frontend.h | DVBFE_ALGO_SEARCH_ERROR | Open |
net/dst.h | DST_FEATURE_ECN_CA (1 « 31) | Open |
net/gue.h | GUE_PFLAG_REMCSUM | Open |
rdma/ib_verbs.h | IB_QP_CREATE_RESERVED_END | Open |
rdma/ib_verbs.h | IB_SEND_RESERVED_END | Open |
video/atmel_lcdc.h | ATMEL_LCDC_MEMOR | Open |
video/atmel_lcdc.h | ATMEL_LCDC_MEMOR_LITTLE | Open |
video/pm3fb.h | PM3PixelSize_INDIVIDUAL | Open |
video/pm3fb.h | PM3Render2D_TextureEnable | Open |
video/radeon.h | RB2D_DC_BUSY | Open |
video/radeon.h | HORZ_AUTO_RATIO_INC | Open |
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.