- 14 Jun, 2021 3 commits
-
-
Dwaipayan Ray authored
Add and document more checkpatch message types. About 50% of all message types are documented now. In addition to this: - Create a new subsection 'Indentation and Line Breaks'. - Rename subsection 'Comment style' to simply 'Comments'. - Refactor some of the existing types to appropriate subsections. Reviewed-by:
Lukas Bulwahn <lukas.bulwahn@gmail.com> Tested-by:
Dwaipayan Ray <dwaipayanray1@gmail.com> Link: https://lore.kernel.org/r/20210614141132.6881-1-dwaipayanray1@gmail.comSigned-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Baoquan He authored
Some parts of the guide are aged, hence need be updated. 1) The backup area of the 1st 640K on X86_64 has been removed by below commits, update the description accordingly. commit 7c321eb2 ("x86/kdump: Remove the backup region handling") commit 6f599d84 ("x86/kdump: Always reserve the low 1M when the crashkernel option is specified") 2) Sort out the descripiton of "crashkernel syntax" part. 3) And some other minor cleanups. Signed-off-by:
Baoquan He <bhe@redhat.com> Acked-by:
Dave Young <dyoung@redhat.com> Link: https://lore.kernel.org/r/20210609083218.GB591017@MiWiFi-R3L-srv [jc: added blank line to fix added build warning] Signed-off-by:
-
Carlos Llamas authored
Since commit 72deb455 ("block: remove CONFIG_LBDAF") sector_t and blkcnt_t types are no longer variable in size, making them unsuitable examples for casting to the largest possible type. This patch replaces such examples with cycles_t and blk_status_t types, whose sizes depend on architecture and config options respectively. Signed-off-by:
Carlos Llamas <cmllamas@google.com> Link: https://lore.kernel.org/r/20210609195058.3518943-1-cmllamas@google.comSigned-off-by:
-
- 13 Jun, 2021 2 commits
-
-
Kir Kolyshkin authored
Commit acda97ac changes dax.txt to dax.rst. Fix the references accordingly. Cc: Igor Matheus Andrade Torrente <igormtorrente@gmail.com> Signed-off-by:
Kir Kolyshkin <kolyshkin@gmail.com> Link: https://lore.kernel.org/r/20210611030044.1982911-4-kolyshkin@gmail.comSigned-off-by:
-
Colin Ian King authored
There is a double "the" in a message in kernel-chktaint, fix it. Signed-off-by:
Colin Ian King <colin.king@canonical.com> Link: https://lore.kernel.org/r/20210613202059.80403-1-colin.king@canonical.comSigned-off-by:
-
- 04 Jun, 2021 8 commits
-
-
Igor Matheus Andrade Torrente authored
Change the file extension and add the rst constructs to integrate this doc to the documentation infrastructure and take advantage of rst features. Signed-off-by:
Igor Matheus Andrade Torrente <igormtorrente@gmail.com> Link: https://lore.kernel.org/r/20210531130515.10309-1-igormtorrente@gmail.comSigned-off-by:
-
Nobuhiro Iwamatsu authored
Fix typo in the documentation, changed from 'comatible' to 'compatible. Signed-off-by:
Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Link: https://lore.kernel.org/r/20210531134235.720351-1-iwamatsu@nigauri.orgSigned-off-by:
-
Gao Mingfei authored
Update the description of the device stat files to include the proper number of fields. Signed-off-by:
Gao Mingfei <g199209@gmail.com> Link: https://lore.kernel.org/r/20210601085145.3273-1-g199209@gmail.comSigned-off-by:
-
Kees Cook authored
Replace example code's use of strncpy() with strscpy() functions. Using strncpy() is considered deprecated: https://www.kernel.org/doc/html/latest/process/deprecated.html#strncpy-on-nul-terminated-stringsSigned-off-by:
Kees Cook <keescook@chromium.org> Acked-by:
Dmitry Torokhov <dmitry.torokhov@gmail.com> Link: https://lore.kernel.org/r/20210602202914.4079123-1-keescook@chromium.orgSigned-off-by:
-
Rob Herring authored
With multiple git working directories, '.git' may also be a text file linking to the actual git tree instead of a directory. Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Signed-off-by:
Rob Herring <robh@kernel.org> Reviewed-by:
Mauro Carvalho Chehab <mchehab@kernel.org> Tested-by:
-
Wan Jiabing authored
Add new zh translations * zh_CN/dev-tools/kasan.rst and link it to zh_CN/dev-tools/index.rst Reviewed-by:
Fangrui Song <maskray@google.com> Signed-off-by:
Wan Jiabing <wanjiabing@vivo.com> Reviewed-by:
Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/20210603141127.101689-1-wanjiabing@vivo.comSigned-off-by:
-
Hailong Liu authored
Add translation zh_CN/admin-guide/lockup-watchdogs.rst and link it to zh_CN/admin-guide/index.rst while clean its todo entry. Reviewed-by:
Yanteng Si <siyanteng@loongson.cn> Signed-off-by:
Hailong Liu <liu.hailong6@zte.com.cn> Link: https://lore.kernel.org/r/20210603145227.30956-1-liuhailongg6@163.comSigned-off-by:
-
Yanteng Si authored
Translate Documentation/core-api/cachetlb.rst into Chinese. Reviewed-by:
Wu XiangCheng <bobwxc@email.cn> Signed-off-by:
-
- 01 Jun, 2021 6 commits
-
-
Haocheng Xie authored
Fix the usage of "a/the" and improve the readability. Signed-off-by:
Haocheng Xie <xiehaocheng.cn@gmail.com> Link: https://lore.kernel.org/r/20210531083905.25763-1-xiehaocheng.cn@gmail.com [jc: tweaked wording slightly] Signed-off-by:
-
Akira Yokosawa authored
Setting a reasonable width to \tymin prevents column squeezing by tabulary. Width of 20em works well in almost all the tables still in the ascii-art format. Excerpt from tabulary package documentation at [1]: To stop very narrow columns being too 'squeezed' by this process any columns that are narrower than \tymin are set to their natural width. [1]: https://mirrors.ctan.org/macros/latex/contrib/tabulary/tabulary.pdf Note: Sphinx has its own default value of \tymin set in sphinxlatextables.sty (Sphinx 4.0.2) and sphinxmulticell.sty (Sphinx 2.4.4) as follows: \setlength{\tymin}{3\fontcharwd\font`0 } , which is not sufficient for kernel-doc. Tested against Sphinx versions 2.4.4 and 4.0.2. Signed-off-by:Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/277d68fa-c96a-0ccb-6ce0-4d314851d9fe@gmail.comSigned-off-by:
-
Yanteng Si authored
Translate Documentation/core-api/padata.rst into Chinese. Signed-off-by:
-
Yanteng Si authored
Translates Documentation/core-api/symbol-namespaces.rst into Chinese. Signed-off-by:
-
Mauro Carvalho Chehab authored
The pip packages are only needed when the distro-provided Sphinx version is not good enough. Don't recommend installing it if not needed. Signed-off-by:
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/04ce53b77b37f1e495c3abc39c2d3dc407895dc0.1621949137.git.mchehab+huawei@kernel.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
The sphinx-pre-install supports installing sphinx via a virtual environment using pip/pypi or directly from the distribution's package, when --no-virtualenv is used. However, even when --no-virtualenv, the current logic is still recomending to install a virtual env, due to a regression. It turns that the logic there is complex, as it depends on several different conditions. Split the code which recommends Sphinx on two separate functions, in order to clean up the code. Signed-off-by:
-
- 27 May, 2021 7 commits
-
-
Yanteng Si authored
Two new commits were added to the original document: commit ddba35031db2ea89facc91c745e5ad55ba2e0e7f commit 20bc8c1e translate them into Chinese. Signed-off-by:
-
Yanteng Si authored
Translate Documentation/core-api/local_ops.rst into Chinese. Signed-off-by:
-
Yanteng Si authored
Translate Documentation/core-api/refcount-vs-atomic.rst into Chinese. Signed-off-by:
-
Barry Song authored
risc-v and arm64 support numa=off by common arch_numa_init() in drivers/base/arch_numa.c. x86, ppc, mips, sparc support it by arch-level early_param. numa=off is widely used in linux distributions. it is better to document it. Signed-off-by:
Barry Song <song.bao.hua@hisilicon.com> Link: https://lore.kernel.org/r/20210524051715.13604-1-song.bao.hua@hisilicon.comSigned-off-by:
-
Mauro Carvalho Chehab authored
The description of those vars produce this warning: Documentation/ABI/testing/sysfs-bus-iio:799: WARNING: Inline emphasis start-string without end-string. Due to an asterisk, which is the markup for emphasis. One possible fix would be to use ``*_timeout`` to avoid it, but looking at the descriptions of other fields in this file, a common pattern is to refer to "these" when talking about the API calls that are described. So, change the text in order to preserve the meaning while avoiding the need of using an asterisk there. Reported-by:
Matthew Wilcox <willy@infradead.org> Signed-off-by:
Jonathan Cameron <Jonathan.Cameron@huawei.com> Link: https://lore.kernel.org/r/dbf0d94f85217f103d77dc8389c8db272f5702d2.1621944866.git.mchehab+huawei@kernel.org [jc fixed specifiy->specify] Signed-off-by:
-
Mauro Carvalho Chehab authored
Descrption -> Description This causes some errors when parsed via scripts/get_abi.pl. Signed-off-by:
-
Akira Yokosawa authored
Activating xeCJK in English and Italian-translation documents results in sub-optimal typesetting with wide-looking apostrophes and quotation marks. The xeCJK package provides macros for enabling and disabling its effect in the middle of a document, namely \makexeCJKactive and \makexeCJKinactive. So the goal of this change is to activate xeCJK in the relevant chapters in translations. To do this: o Define custom macros in the preamble depending on the availability of the "Noto Sans CJK" font so that those macros can be used regardless of the use of xeCJK package. o Patch \sphinxtableofcontents so that xeCJK is inactivated after table of contents. o Embed those custom macros in each language's index.rst file as a ".. raw:: latex" construct. Note: A CJK chapter needs \kerneldocCJKon in front of its chapter heading, while a non-CJK chapter should have \kerneldocCJKoff below its chapter heading. This is to make sure the CJK font is available to CJK chapter's heading and ending page's footer. Tested against Sphinx versions 2.4.4 and 4.0.2. Signed-off-by:
-
- 20 May, 2021 14 commits
-
-
Andrew Jeffery authored
While include/linux/bitops.h brings in the BIT() macro, it was moved to include/linux/bits.h in commit 8bd9cb51 ("locking/atomics, asm-generic: Move some macros from <linux/bitops.h> to a new <linux/bits.h> file"). Since that commit BIT() has moved again into include/vdso/bits.h via commit 3945ff37 ("linux/bits.h: Extract common header for vDSO"). I think the move to the vDSO header can be considered an implementation detail, so for now update the checkpatch documentation to recommend use of include/linux/bits.h. Signed-off-by:
Andrew Jeffery <andrew@aj.id.au> Acked-by:
Jiri Slaby <jirislaby@kernel.org> Acked-by:
-
Yue Hu authored
It is 'driver' to complete the request. Also remove a redundant space. Signed-off-by:
Yue Hu <huyue2@yulong.com> Link: https://lore.kernel.org/r/20210520074225.1989-1-zbestahu@gmail.comSigned-off-by:
-
Yanteng Si authored
This patch translates Documentation/parisc/registers.rst into Chinese. Signed-off-by:
-
Yanteng Si authored
This patch translates Documentation/parisc/debugging.rst into Chinese. Signed-off-by:
-
Yanteng Si authored
This patch translates Documentation/parisc/index.rst into Chinese. Signed-off-by:
-
Dwaipayan Ray authored
- Document a couple of more checkpatch message types. - Add a blank line before all `See:` lines to improve the rst output. - Create a new subsection `Permissions` and move a few types to it. Signed-off-by:
-
Wei Ming Chen authored
Replace /* fall through */ comment with fallthrough, make it align with original process/coding-style.rst Signed-off-by:
Wei Ming Chen <jj251510319013@gmail.com> Link: https://lore.kernel.org/r/20210515155142.2490-1-jj251510319013@gmail.comSigned-off-by:
-
Tiezhu Yang authored
It should use post_handler instead of pre_handler in handler_post(). As Joe Perches suggested, it would be better to use pr_fmt and remove all the embedded pre/post/fault strings. This would change the style of the output through. Fixes: e16c5dd5 ("samples/kprobes: Add s390 case in kprobe example module") Suggested-by:
Joe Perches <joe@perches.com> Signed-off-by:
Tiezhu Yang <yangtiezhu@loongson.cn> Acked-by:
Marc Koderer <marc@koderer.com> Acked-by:
Masami Hiramatsu <mhiramat@kernel.org> Link: https://lore.kernel.org/r/1621218083-23519-3-git-send-email-yangtiezhu@loongson.cnSigned-off-by:
-
Tiezhu Yang authored
Fix a defective format in handler_fault() ending with an 'n' that should be '\n'. Suggested-by:
-
Mauro Carvalho Chehab authored
As reported by scripts/get_abi.pl: Warning: /sys/class/leds/<led>/repeat is defined 2 times: Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0 Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 The definition for the EL15203000 is just a special case of the sysfs led class. So, drop it and mentions the possible exception at the class definition. Signed-off-by:
-
Mauro Carvalho Chehab authored
./scripts/get_abi.pl is warning about duplicated symbol definition: Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4 ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 What happens is that 3 drivers use the same pattern to report max and dim setting for different ambient light zones. It should be noticed that the adp8870 doc was missing an entry for l1_daylight_dim, which was fixed on this patch. While the ambient light zone is device-specific, the sysfs definition is actually common. So, unify them at: Documentation/ABI/testing/sysfs-class-backlight and use as the contact point, the e-mail reported by get_maintainers.pl for the subsystem. Signed-off-by:
-
Mauro Carvalho Chehab authored
./scripts/get_abi.pl is reporting a duplicated definition for /sys/kernel/iommu_groups/reserved_regions, both at the same file: Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 Documentation/ABI/testing/sysfs-kernel-iommu_groups:27 Fix it by merging those into an unified entry. Signed-off-by:
-
Mauro Carvalho Chehab authored
The document which describes the SGX kernel architecture was added at commit 3fa97bf0 ("Documentation/x86: Document SGX kernel architecture") but the reference at virt/kvm/api.rst is pointing to some non-existing document. Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset 5513b411 ("Documentation: rename pinctl to pin-control") renamed: Documentation/driver-api/pinctl.rst to: Documentation/driver-api/pin-control.rst. Update the cross-references accordingly. Fixes: 5513b411 ("Documentation: rename pinctl to pin-control") Signed-off-by:
Charles Keepax <ckeepax@opensource.cirrus.com> Acked-by:
Lee Jones <lee.jones@linaro.org> Link: https://lore.kernel.org/r/46ac2e918c7c4a4b701d54870f167b78466ec578.1621413933.git.mchehab+huawei@kernel.orgSigned-off-by:
-
