aboutsummaryrefslogtreecommitdiff
AgeCommit message (Collapse)Author
2021-02-01Move our minimum Sphinx version to 1.7Jonathan Corbet
As promised, drop support for some ancient sphinx releases, along with a lot of the cruft that was required to make that support work. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28Documentation: input: define ABS_PRESSURE/ABS_MT_PRESSURE resolution as gramsPeter Hutterer
ABS_PRESSURE and ABS_MT_PRESSURE on touch devices usually represent contact size (as a finger flattens with higher pressure the contact size increases) and userspace translates the kernel pressure value back into contact size. For example, libinput has pressure thresholds when a touch is considered a palm (palm == large contact area -> high pressure). The values themselves are on an arbitrary scale and device-specific. On pressurepads however, the pressure axis may represent the real physical pressure. Pressurepads are touchpads without a hinge but an actual pressure sensor underneath the device instead, for example the Lenovo Yoga 9i. A high-enough pressure is converted to a button click by the firmware. Microsoft does not require a pressure axis to be present, see [1], so as seen from userspace most pressurepads are identical to clickpads - one button and INPUT_PROP_BUTTONPAD set. However, pressurepads that export the pressure axis break userspace because that axis no longer represents contact size, resulting in inconsistent touch tracking, e.g. [2]. Userspace needs to know when a pressure axis represents real pressure and the best way to do so is to define what the resolution field means. Userspace can then treat data with a pressure resolution as true pressure. This patch documents that the pressure resolution is in units/gram. This allows for fine-grained detail and tops out at roughly ~2000t, enough for the devices we're dealing with. Grams is not a scientific pressure unit but the alternative is: - Pascal: defined as force per area and area is unreliable on many devices and seems like the wrong option here anyway, especially for devices with a single pressure sensor only. - Newton: defined as mass * distance/acceleration and for the purposes of a pressure axis, the distance is tricky to interpret and we get the data to calculate acceleration from event timestamps anyway. For the purposes of touch devices and digitizers, grams seems the best choice and the easiest to interpret. Bonus side effect: we can use the existing hwdb infrastructure in userspace to fix devices that advertise false pressure. [1] https://docs.microsoft.com/en-us/windows-hardware/design/component-guidelines/windows-precision-touchpad-required-hid-top-level-collections#windows-precision-touchpad-input-reports [2] https://gitlab.freedesktop.org/libinput/libinput/-/issues/562 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Benjamin Tissoires <benjamin.tissoires@redhat.com> Link: https://lore.kernel.org/r/20210112230310.GA149342@jelly Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28scripts/kernel-doc: add internal hyperlink to DOC: sectionsMichal Wajdeczko
While DOC: section titles are not converted into RST headings sections and are only decorated with strong emphasis markup, nothing stops us from generating internal hyperlinks for them, to mimic implicit hyperlinks to RST headings. Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Jani Nikula <jani.nikula@intel.com> Cc: Chris Wilson <chris@chris-wilson.co.uk> Link: https://lore.kernel.org/r/20210118110813.1490-1-michal.wajdeczko@intel.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28Update Documentation/admin-guide/sysctl/fs.rstEric Curtin
max_user_watches for epoll should say 1/25, rather than 1/32 Signed-off-by: Eric Curtin <ericcurtin17@gmail.com> Link: https://lore.kernel.org/r/20210120132648.19046-1-ericcurtin17@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28docs: Update DTB format referencesMilan Lakhani
There were two references to devicetree/booting-without-of.rst (which has been removed) for DTB format information, and devicetree/usage-model.rst pointed to https://elinux.org/Device_Tree_Usage. Change all three of these references to https://www.devicetree.org/specifications/. Signed-off-by: Milan Lakhani <milan.lakhani@codethink.co.uk> Link: https://lore.kernel.org/r/1611149511-4990-1-git-send-email-milan.lakhani@codethink.co.uk Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28docs: zh_CN: add iio index.rst translationYanteng Si
This patch translates Documentation/iio/index.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com> Reviewed-by: Huacai Chen <chenhuacai@kernel.org> Link: https://lore.kernel.org/r/20210121033302.558935-3-siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28docs/zh_CN: add iio ep93xx_adc.rst translationYanteng Si
This patch translates Documentation/iio/ep93xx_adc.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com> Reviewed-by: Huacai Chen <chenhuacai@kernel.org> Link: https://lore.kernel.org/r/20210121033302.558935-2-siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28docs/zh_CN: add iio iio_configfs.rst translationYanteng Si
This patch translates Documentation/iio/iio_configfs.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com> Reviewed-by: Huacai Chen <chenhuacai@kernel.org> Link: https://lore.kernel.org/r/20210121033302.558935-1-siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28Documentation: ARM: fix reference to DT format documentationBaruch Siach
The booting-without-of.rst file is no longer there. Link to devicetree.org instead. Fixes: 441848282c590 ("dt: Remove booting-without-of.rst") Signed-off-by: Baruch Siach <baruch@tkos.co.il> Cc: Rob Herring <robh@kernel.org> Link: https://lore.kernel.org/r/7f07e544d9fc584242d496c2f54f9303d8de0724.1611558630.git.baruch@tkos.co.il Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28Documentation/admin-guide: kernel-parameters: update CMA entriesRandy Dunlap
Add qualifying build option legend [CMA] to kernel boot options that requirce CMA support to be enabled for them to be usable. Also capitalize 'CMA' when it is used as an acronym. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Mike Kravetz <mike.kravetz@oracle.com> Link: https://lore.kernel.org/r/20210125043202.22399-1-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28Documentation: arm: marvell: Update link to unrestricted Armada 38x ↵Pali Rohár
Functional Spec On Marvell website is documentation accessible without need to register or fill any other forms. Signed-off-by: Pali Rohár <pali@kernel.org> Link: https://lore.kernel.org/r/20210125141529.32357-1-pali@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28Documentation: arm: marvell: Fix dead link to Armada 37xx Product BriefPali Rohár
Signed-off-by: Pali Rohár <pali@kernel.org> Link: https://lore.kernel.org/r/20210125141341.32200-1-pali@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28Documentation: arm: marvell: Add link to public Armada 37xx Hardware SpecPali Rohár
Signed-off-by: Pali Rohár <pali@kernel.org> Reviewed-by: Andrew Lunn <andrew@lunn.ch> Link: https://lore.kernel.org/r/20210121193418.22678-2-pali@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28Documentation: arm: Fix marvell file namePali Rohár
Fixes: dc7a12bdfccd ("docs: arm: convert docs to ReST and rename to *.rst") Signed-off-by: Pali Rohár <pali@kernel.org> Reviewed-by: Andrew Lunn <andrew@lunn.ch> Link: https://lore.kernel.org/r/20210121193418.22678-1-pali@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28Documentation/x86/boot.rst: Correct the example of SETUP_INDIRECTCao jin
struct setup_data.len is the length of data field. In case of SETUP_INDIRECT, it should be sizeof(setup_indirect). Signed-off-by: Cao jin <jojing64@gmail.com> Reviewed-by: Daniel Kiper <daniel.kiper@oracle.com> Link: https://lore.kernel.org/r/20210127084911.63438-1-jojing64@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-28Documentation: kernel-parameters: add missing '<'Wolfram Sang
Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com> Link: https://lore.kernel.org/r/20210127104343.5647-1-wsa+renesas@sang-engineering.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21selftests: kselftest_harness.h: partially fix kernel-doc markupsMauro Carvalho Chehab
The kernel-doc markups on this file are weird: they don't follow what's specified at: Documentation/doc-guide/kernel-doc.rst In particular, markups should use this format: identifier - description and not this: identifier(args) The way the definitions are inside this file cause the parser to completely miss the identifier name of each function. This prevents improving the script to do some needed validation tests. Address this part. Yet, furter changes are needed in order for it to fully follow the specs. Acked-by: Kees Cook <keescook@chromium.org> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/8383758160fdb4fcbb2ac56beeb874ca6dffc6b9.1610610937.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21w1: fix a kernel-doc markupMauro Carvalho Chehab
A function has a different name between their prototype and its kernel-doc markup. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/2dc136ff6290d7c8919599d21bee244f31647c8c.1610610937.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21memblock: fix kernel-doc markupsMauro Carvalho Chehab
Some identifiers have different names between their prototypes and the kernel-doc markup. Acked-by: Mike Rapoport <rppt@linux.ibm.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/f3c65f61367993a607f9daf9dc1a3bdab1f0a040.1610610937.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21lib/crc7: fix a kernel-doc markupMauro Carvalho Chehab
A function has a different name between their prototype and its kernel-doc markup. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/1963266e84c6fb0154602f276b04887c85f80bd3.1610610937.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21connector: fix a kernel-doc markupMauro Carvalho Chehab
A function has a different name between their prototype and its kernel-doc markup. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/889cfb141a98ae06d5bc79b744786ec2e8f92d93.1610610937.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21firmware: stratix10-svc: fix kernel-doc markupsMauro Carvalho Chehab
There are some common comments marked, instead, with kernel-doc notation, which won't work. While here, rename an identifier, in order to match the function prototype below kernel-doc markup. Acked-by: Richard Gong <richard.gong@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/02a1eb47767e01e875d8840805b8b2d4f3c6bdee.1610610937.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21pstore/zone: fix a kernel-doc markupMauro Carvalho Chehab
The documented struct is psz_head and not psz_buffer. Reviewed-by: Kees Cook <keescook@chromium.org> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/a67ca4d12c3ef277dadb9e0d0df8450158e637cc.1610610937.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21fs: fix kernel-doc markupsMauro Carvalho Chehab
Two markups are at the wrong place. Kernel-doc only support having the comment just before the identifier. Also, some identifiers have different names between their prototypes and the kernel-doc markup. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/96b1e1b388600ab092331f6c4e88ff8e8779ce6c.1610610937.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21rapidio: fix kernel-doc a markupMauro Carvalho Chehab
Probaly this was due to a cut and paste issue. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/e23e64983788a51dd9099e2b0d881e1f64ecbc5b.1610610937.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21parport: fix a kernel-doc markupMauro Carvalho Chehab
The kernel-doc markup inside share.c is actually for __parport_register_driver. The actual goal seems to be to document parport_register_driver(). So, fix the existing markup and add a new one. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/dc0778af8c466cc667409ead05876a5cfd3cbece.1610610937.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21AFS: Documentation: fix a few typos in afs.rstRandy Dunlap
Fix typos (punctuation, grammar, spelling) in afs.rst. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: David Howells <dhowells@redhat.com> Cc: linux-afs@lists.infradead.org Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Link: https://lore.kernel.org/r/20210117213351.1075-1-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21docs/zh_CN: remove cn_index tag in mipsAlex Shi
It's a unused tag with a incorrect big name but just for mips arch. So remove it. Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com> Cc: Yanteng Si <siyanteng@loongson.cn> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Link: https://lore.kernel.org/r/20210121024113.16344-1-alex.shi@linux.alibaba.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21docs: iio: Correct a typoYanteng Si
There are two EP9312, one of them should be 9315 Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20210119030320.2860870-1-siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21arch/Kconfig: update a broken file referenceLukas Bulwahn
Commit adab66b71abf ("Revert: "ring-buffer: Remove HAVE_64BIT_ALIGNED_ACCESS"") added the config HAVE_64BIT_ALIGNED_ACCESS back into arch/Kconfig with this revert. In the meantime, commit c9b54d6f362c ("docs: move other kAPI documents to core-api") changed ./Documentation/unaligned-memory-access.txt to ./Documentation/core-api/unaligned-memory-access.rst. Fortunately, ./scripts/documentation-file-ref-check detects this and warns about this broken reference. Update the file reference in arch/Kconfig. Fixes: adab66b71abf ("Revert: "ring-buffer: Remove HAVE_64BIT_ALIGNED_ACCESS"") Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20210119095326.13896-1-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21docs/admin-guide/cgroup-v2: fix mount opt renderingKir Kolyshkin
Due to an extra empty line between the option and its description it is rendered not like in other places. Remove the empty lines to fix. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com> Acked-by: Tejun Heo <tj@kernel.org> Link: https://lore.kernel.org/r/20210120001824.385168-11-kolyshkin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21docs/admin-guide/cgroup-v2: nitKir Kolyshkin
Improper Capitalization. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com> Acked-by: Tejun Heo <tj@kernel.org> Link: https://lore.kernel.org/r/20210120001824.385168-10-kolyshkin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21doc/admin-guide/cgroup-v2: use tablesKir Kolyshkin
These two places are rendered like a table in the source (rst) code, but they are seen as plain text by formatters, and thus are joined together into a single line, e.g.: > “root” - a partition root “member” - a non-root member of a partition This is definitely not what was intended. To fix, use table formatting, like in other places. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com> Acked-by: Tejun Heo <tj@kernel.org> Link: https://lore.kernel.org/r/20210120001824.385168-9-kolyshkin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21docs/admin-guide: cgroup-v2: fix cgroup.type renderingKir Kolyshkin
Due to an extra vertical whitespace, this was not recognised as a definition list entry, and thus was not rendered like the rest of cgroupfs files. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com> Acked-by: Tejun Heo <tj@kernel.org> Link: https://lore.kernel.org/r/20210120001824.385168-8-kolyshkin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21docs/admin-guide: cgroup-v2: typos and spacesKir Kolyshkin
- fix a typo (mempry -> memory) in a file name; - add space before "(" where appropriate. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com> Acked-by: Tejun Heo <tj@kernel.org> Link: https://lore.kernel.org/r/20210120001824.385168-7-kolyshkin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21docs/scheduler/sched-bwc: note/link cgroup v2Kir Kolyshkin
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com> Acked-by: Tejun Heo <tj@kernel.org> Link: https://lore.kernel.org/r/20210120001824.385168-6-kolyshkin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21docs/scheduler/sched-bwc: fix note renderingKir Kolyshkin
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com> Acked-by: Tejun Heo <tj@kernel.org> Link: https://lore.kernel.org/r/20210120001824.385168-4-kolyshkin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21docs/scheduler/sched-design-CFS: formatting fixKir Kolyshkin
Fix the rendering of the paragraph. Before the fix, the first line is rendered in bold (I'm not quite sure why) and is also separated from the rest of the paragraph, which is rendered with an indent. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com> Acked-by: Tejun Heo <tj@kernel.org> Link: https://lore.kernel.org/r/20210120001824.385168-3-kolyshkin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-21docs/scheduler/sched-bwc: formatting fixKir Kolyshkin
Since commit d6a3b247627a3 these three lines are merged into one by the RST processor, making it hard to read. Use bullet points to separate the entries, like it's done in other similar places. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com> Acked-by: Tejun Heo <tj@kernel.org> Link: https://lore.kernel.org/r/20210120001824.385168-2-kolyshkin@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-18scripts: kernel-doc: validate kernel-doc markup with the actual namesMauro Carvalho Chehab
Kernel-doc currently expects that the kernel-doc markup to come just before the function/enum/struct/union/typedef prototype. Yet, if it find things like: /** * refcount_add - add a value to a refcount * @i: the value to add to the refcount * @r: the refcount */ static inline void __refcount_add(int i, refcount_t *r, int *oldp); static inline void refcount_add(int i, refcount_t *r); Kernel-doc will do the wrong thing: foobar.h:6: warning: Function parameter or member 'oldp' not described in '__refcount_add' .. c:function:: void __refcount_add (int i, refcount_t *r, int *oldp) add a value to a refcount **Parameters** ``int i`` the value to add to the refcount ``refcount_t *r`` the refcount ``int *oldp`` *undescribed* Basically, it will document "__refcount_add" with the kernel-doc markup for refcount_add. If both functions have the same arguments, this won't even produce any warning! Add a logic to check if the kernel-doc identifier matches the actual name of the C function or data structure that will be documented. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/081546f141a496d6cabb99a4adc140444c705e93.1610610937.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-18Documentation: fix typos in split page table lock descriptionRolf Eike Beer
Signed-off-by: Rolf Eike Beer <eb@emlix.com> Link: https://lore.kernel.org/r/2338863.uUFqZTUbry@devpool47 Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-18docs: Remove make headers_check from checklistMilan Lakhani
Remove the make headers_check step from submit-checklist.rst as this is no longer functional. Signed-off-by: Milan Lakhani <milan.lakhani@codethink.co.uk> Link: https://lore.kernel.org/r/1610458861-2832-1-git-send-email-milan.lakhani@codethink.co.uk Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-18samples/kprobes: Add ARM supportMarc Koderer
Plenty of architectures are already supported and this adds ARM support. Signed-off-by: Marc Koderer <marc@koderer.com> Acked-by: Masami Hiramatsu <mhiramat@kernel.org> Link: https://lore.kernel.org/r/20210112154054.17138-1-marc@koderer.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-18docs: submitting-patches: Emphasise the requirement to Cc: stable when using ↵Lee Jones
Fixes: tag Clear-up any confusion surrounding the Fixes: tag with regards to the need to Cc: the stable mailing list when submitting stable patch candidates. Signed-off-by: Lee Jones <lee.jones@linaro.org> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Link: https://lore.kernel.org/r/20210113163315.1331064-1-lee.jones@linaro.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-18docs/kokr: Link memory-barriers.txt to rstSeongJae Park
This commit links Korean translation of 'memory-barriers.txt' in the translations index rst file as the original version is linked in 'Documentation/staging/index.rst'. Signed-off-by: SeongJae Park <sjpark@amazon.de> Link: https://lore.kernel.org/r/20210117100931.9347-4-sj38.park@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-18docs/kokr: make reporting-bugs.rst obsoleteSeongJae Park
Translate this commit to Korean: da514157c4f0 ("docs: make reporting-bugs.rst obsolete") Signed-off-by: SeongJae Park <sjpark@amazon.de> Link: https://lore.kernel.org/r/20210117100931.9347-3-sj38.park@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-18Documentation/kokr/howto: Replace HTTP links with HTTPS ones: ↵SeongJae Park
Documentation/process Apply this commit to Korean: e7b4311ebcac ("Replace HTTP links with HTTPS ones: Documentation/process") Signed-off-by: SeongJae Park <sjpark@amazon.de> Link: https://lore.kernel.org/r/20210117100931.9347-2-sj38.park@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-18docs: process/howto.rst: make sections on bug reporting match practiceThorsten Leemhuis
The file Documentation/process/howto.rst points to bugzilla.kernel.org as the primary place to report kernel bugs to. For most of the kernel that's the wrong place, as the MAINTAINERS file shows. Adjust those sections to make them match current practice. This change also removes a contradiction with the recently added text Documentation/admin-guide/reporting-issues.rst, which is a reason for a 'this needs further discussion' warning note in there. The change is thus a prerequisite to remove that warning, nevertheless it is left for now to make sure people review the text's approach more carefully. Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info> Acked-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20210116143542.69199-1-linux@leemhuis.info Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-13doc/zh_CN: mips: use doc references insteadLukas Bulwahn
The Chinese mips translations refer to non-existing labels in the original documentation. Hence, make htmldocs warns about those undefined labels on all files in ./Documentation/translations/zh_CN/mips/. Replace the references to non-existing labels with suitable doc references. Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Fixes: 419b1d4ed1cb ("doc/zh_CN: add mips ingenic-tcu.rst translation") Fixes: 72bc9d08868d ("doc/zh_CN: add mips features.rst translation") Fixes: 7fd3954b0c52 ("doc/zh_CN: add mips booting.rst translation") Fixes: b8e724fd7117 ("doc/zh_CN: add mips index.rst translation") Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Link: https://lore.kernel.org/r/20210113070557.28792-1-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-01-13doc/zh_CN: adjust table markup in mips/ingenic-tcu.rstLukas Bulwahn
Commit 419b1d4ed1cb ("doc/zh_CN: add mips ingenic-tcu.rst translation") introduces a warning with make htmldocs: ./Documentation/translations/zh_CN/mips/ingenic-tcu.rst: 61: WARNING: Malformed table. Text in column margin in table line 6. Adjust the table markup to address this warning. Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Fixes: 419b1d4ed1cb ("doc/zh_CN: add mips ingenic-tcu.rst translation") Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Link: https://lore.kernel.org/r/20210113070023.25064-1-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>