Fix new html build warnings from next-20201001
Status from this message: Applied to next, thanks!
Get series with b4
b4 am [email protected]Versions newest first
Patches in v1 Applied
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/6 | net: core: document two new elements of struct net_deviceinclude/ | +5 | 1 reply | |
| 2/6 | docs: vcpu.rst: fix some build warningsDocumentation/ | +13 | 1 reply | |
| 3/6 | docs: virt: user_mode_linux_howto_v2.rst: fix a literal block markupDocumentation/ | +1 | 1 reply | |
| 4/6 | docs: i2c: index.rst: add slave-testunit-backend.rstDocumentation/ Documentation/ | +2 | 2 replies | |
| 5/6 | scripts: kernel-doc: add support for typedef enumscripts/ | +11 | 2 replies | |
| 6/6 | docs: gpio: add a new document to its index.rstDocumentation/ | +1 | 3 replies |
Reviews trailers per patch
3 of 6 patches have a Reviewed-by or Acked-by.
| Patch | Anton Ivanov | Paolo Bonzini | Bartosz Golaszewski |
|---|---|---|---|
| 1/6 | |||
| 2/6 | A-b | ||
| 3/6 | A-b | ||
| 4/6 | |||
| 5/6 | |||
| 6/6 | A-b |
Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 3 reviewers.
Cover letter [PATCH 0/6] Fix new html build warnings from next-20201001
There are some new warnings when building the documentation from yesterday's linux next. This small series fix them.
- patch 1 documents two new kernel-doc parameters on a net core file. I used the commit log in order to help documenting them;
- patch 2 fixes some tags at UMLv2 howto;
- patches 3 and 5 add some new documents at the corresponding index file.
- patch 4 changes kernel-doc script for it to recognize typedef enums.
Patch 4 should probably be merged via docs tree, but the others are against stuff recently added at linux-next. So, the better is to merge them directly at the trees which introduced the issue.
-
As a reference, the patches fixing all html build warnings are at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=sphinx3-fixes-v3
Such series also adds support for Sphinx versions 3.1 and above.
It should be noticed that, with Sphinx version 3 and above, there are a few new warnings, because currently Sphinx assumes a that names are unique for all C symbols. There are a few cases where we have the same name for a function and for a struct at the Kernel. Upstream is already working on a solution for that.
So, for now, I recomend doing html builds with version < 3.
Mauro Carvalho Chehab (6):
net: core: document two new elements of struct net_device
docs: vcpu.rst: fix some build warnings
docs: virt: user_mode_linux_howto_v2.rst: fix a literal block markup
docs: i2c: index.rst: add slave-testunit-backend.rst
scripts: kernel-doc: add support for typedef enum
docs: gpio: add a new document to its index.rst
Documentation/admin-guide/gpio/index.rst | 1 + .../admin-guide/hw-vuln/l1d_flush.rst | 3 +-- Documentation/i2c/index.rst | 1 + Documentation/virt/kvm/devices/vcpu.rst | 26 +++++++++---------- .../virt/uml/user_mode_linux_howto_v2.rst | 1 + include/linux/netdevice.h | 5 ++++ scripts/kernel-doc | 15 ++++++++--- 7 files changed, 33 insertions(+), 19 deletions(-)
Signature · 1 line
2.26.2