From: Yanteng Si <siyanteng01@gmail.com>
To: corbet@lwn.net
Cc: Yanteng Si <siyanteng@loongson.cn>,
chenhuacai@kernel.org, linux-doc@vger.kernel.org,
siyanteng01@gmail.com
Subject: [PATCH 00/11] docs: fix build warning
Date: Sun, 5 Dec 2021 21:43:49 +0800 [thread overview]
Message-ID: <cover.1638706875.git.siyanteng@loongson.cn> (raw)
I can't stand these red warnings anymore, especially when I'm testing my
patches and looking for my own warnings in a sea of warnings. so, let's
fix them!
* Patch 0001 optimized the layout of the n_gsm.rst document, which would make the html rendering incorrect.
* Patch 0002-0011 Fix warning as:
linux-next/Documentation/admin-guide/device-mapper/writecache.rst:23: WARNING: Unexpected indentation.
linux-next/Documentation/arm64/tagged-address-abi.rst:52: WARNING: Unexpected indentation.
linux-next/Documentation/filesystems/netfs_library.rst:519: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/filesystems/netfs_library.rst:519: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/vm/page_owner.rst:92: WARNING: Unexpected indentation.
linux-next/Documentation/vm/page_owner.rst:96: WARNING: Unexpected indentation.
linux-next/Documentation/vm/page_owner.rst:107: WARNING: Unexpected indentation.
linux-next/Documentation/virt/kvm/api.rst:6046: WARNING: Literal block ends without a blank line; unexpected unindent.
linux-next/Documentation/virt/kvm/api.rst:7296: WARNING: Title underline too short.
8.28 KVM_CAP_ENFORCE_PV_FEATURE_CPUID
-----------------------------
linux-next/Documentation/virt/kvm/api.rst:7296: WARNING: Title underline too short.
8.28 KVM_CAP_ENFORCE_PV_FEATURE_CPUID
-----------------------------
linux-next/Documentation/driver-api/serial/n_gsm.rst:23: WARNING: Definition list ends without a blank line; unexpected unindent.
linux-next/Documentation/driver-api/serial/n_gsm.rst:100: WARNING: Definition list ends without a blank line; unexpected unindent.
linux-next/Documentation/driver-api/serial/n_gsm.rst:115: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/driver-api/serial/n_gsm.rst:118: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/driver-api/serial/n_gsm.rst:120: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/driver-api/serial/n_gsm.rst:122: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/driver-api/serial/n_gsm.rst:125: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/driver-api/serial/n_gsm.rst:139: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/core-api/idr.rst:20: WARNING: Unknown target name: "xarray".
linux-next/Documentation/admin-guide/gpio/gpio-sim.rst: WARNING: 文档没有加入到任何目录树中
linux-next/Documentation/filesystems/caching/backend-api.rst:417: WARNING: undefined label: documentation/filesystems/netfs_library.rst (if the link has no caption the label must precede a section header)
linux-next/Documentation/trace/boottime-trace.rst:136: WARNING: undefined label: histogram (if the link has no caption the label must precede a section header)
* other:
<https://lore.kernel.org/linux-doc/20211205132141.4124145-1-siyanteng@loongson.cn/T/#u> Fix warning as:
linux-next/Documentation/networking/kapi:122: ./include/linux/phy.h:543: WARNING: Unexpected indentation.
linux-next/Documentation/networking/kapi:122: ./include/linux/phy.h:544: WARNING: Block quote ends without a blank line; unexpected unindent.
linux-next/Documentation/networking/kapi:122: ./include/linux/phy.h:546: WARNING: Unexpected indentation.
<https://lore.kernel.org/linux-doc/20211205131503.4122955-1-siyanteng@loongson.cn/T/#u> Fix warning as:
linux-next/Documentation/driver-api/regulator:166: ./include/linux/regulator/driver.h:96: WARNING: Unexpected indentation.
linux-next/Documentation/driver-api/regulator:166: ./include/linux/regulator/driver.h:98: WARNING: Block quote ends without a blank line; unexpected unindent.
<https://lore.kernel.org/linux-doc/20211205130816.4121898-1-siyanteng@loongson.cn/T/#u> Fix warning as:
linux-next/Documentation/driver-api/generic-counter:234: ./include/linux/counter.h:43: WARNING: Unexpected indentation.
linux-next/Documentation/driver-api/generic-counter:234: ./include/linux/counter.h:45: WARNING: Block quote ends without a blank line; unexpected unindent.
<https://lore.kernel.org/linux-doc/163a4dde20b8c4b68d668977a668e281d18fcf92.1638517064.git.siyanteng@loongson.cn/T/#u> Fix warning as:
linux-next/Documentation/scheduler/sched-bwc.rst:243: WARNING: Inline emphasis start-string without end-string.
* No fix:(These seem tricky,I can't do anything about it for now.)
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:522: WARNING: Unexpected indentation.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:516: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:522: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:522: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:523: WARNING: Block quote ends without a blank line; unexpected unindent.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:526: WARNING: Definition list ends without a blank line; unexpected unindent.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:532: WARNING: Unexpected indentation.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:526: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:526: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:533: WARNING: Block quote ends without a blank line; unexpected unindent.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:542: WARNING: Unexpected indentation.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:535: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:535: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:542: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:542: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:544: WARNING: Block quote ends without a blank line; unexpected unindent.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:546: WARNING: Definition list ends without a blank line; unexpected unindent.
linux-next/Documentation/core-api/kernel-api:81: ./lib/bitmap.c:570: WARNING: Unexpected indentation.
linux-next/Documentation/ABI/testing/sysfs-driver-aspeed-uart-routing:2: WARNING: Inline emphasis start-string without end-string.
linux-next/Documentation/ABI/testing/sysfs-class-thermal:201: WARNING: Bullet list ends without a blank line; unexpected unindent.
linux-next/Documentation/networking/kapi:147: ./drivers/net/phy/phylink.c:1657: WARNING: Unexpected indentation.
linux-next/Documentation/networking/kapi:147: ./drivers/net/phy/phylink.c:1658: WARNING: Block quote ends without a blank line; unexpected unindent.
linux-next/Documentation/gpu/drm-kms-helpers:451: ./drivers/gpu/drm/drm_privacy_screen.c:270: WARNING: Inline emphasis start-string without end-string.
Yanteng Si (11):
docs/driver-api: Reformatting serial ngsm
docs/admin-guide: Add the necessary blank lines to the writecache
docs/arm64: delete a space from tagged-address-abi
docs/vm: delele three spaces from page_owner
docs/filesystems: add four apostrophes to _start and _len
docs/virt: add a blank line and some - to kvm api
docs/driver-api: Replace a comma in the n_gsm.rst with a double colon
docs/core-api: Replace Footnote Reference in document idr with
Substitution Reference
docs/filesystems: fix a label of backend-api
docs/trace: fix a label of boottime-trace
docs/admin-guide: add gpio-aggregator into index
.../admin-guide/device-mapper/writecache.rst | 1 +
Documentation/admin-guide/gpio/index.rst | 1 +
Documentation/arm64/tagged-address-abi.rst | 2 +-
Documentation/core-api/idr.rst | 3 +-
Documentation/core-api/xarray.rst | 1 -
Documentation/driver-api/serial/n_gsm.rst | 246 +++++++++---------
.../filesystems/caching/backend-api.rst | 2 +-
Documentation/filesystems/netfs_library.rst | 2 +-
Documentation/trace/boottime-trace.rst | 2 +-
Documentation/virt/kvm/api.rst | 3 +-
Documentation/vm/page_owner.rst | 6 +-
11 files changed, 139 insertions(+), 130 deletions(-)
--
2.27.0
next reply other threads:[~2021-12-05 13:45 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-05 13:43 Yanteng Si [this message]
2021-12-05 13:43 ` [PATCH 01/11] docs/driver-api: Reformatting serial ngsm Yanteng Si
2021-12-06 17:56 ` Jonathan Corbet
2021-12-09 7:05 ` yanteng si
2021-12-05 13:43 ` [PATCH 02/11] docs/admin-guide: Add the necessary blank lines to the writecache Yanteng Si
2021-12-05 13:43 ` [PATCH 03/11] docs/arm64: delete a space from tagged-address-abi Yanteng Si
2021-12-05 13:43 ` [PATCH 04/11] docs/vm: delele three spaces from page_owner Yanteng Si
2021-12-06 17:58 ` Jonathan Corbet
2021-12-09 7:17 ` yanteng si
2021-12-05 13:43 ` [PATCH 05/11] docs/filesystems: add four apostrophes to _start and _len Yanteng Si
2021-12-05 13:43 ` [PATCH 06/11] docs/virt: add a blank line and some - to kvm api Yanteng Si
2021-12-05 13:43 ` [PATCH 07/11] docs/driver-api: Replace a comma in the n_gsm.rst with a double colon Yanteng Si
2021-12-05 13:43 ` [PATCH 08/11] docs/core-api: Replace Footnote Reference in document idr with Substitution Reference Yanteng Si
2021-12-05 13:43 ` [PATCH 09/11] docs/filesystems: fix a label of backend-api Yanteng Si
2021-12-05 13:43 ` [PATCH 10/11] docs/trace: fix a label of boottime-trace Yanteng Si
2021-12-05 13:44 ` [PATCH 11/11] docs/admin-guide: add gpio-aggregator into index Yanteng Si
2021-12-06 18:09 ` [PATCH 00/11] docs: fix build warning Jonathan Corbet
2021-12-07 11:25 ` yanteng si
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cover.1638706875.git.siyanteng@loongson.cn \
--to=siyanteng01@gmail.com \
--cc=chenhuacai@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=siyanteng@loongson.cn \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.