[PATCH 00/11] docs: fix build warning

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxxxx/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@xxxxxxxxxxx/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@xxxxxxxxxxx/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@xxxxxxxxxxx/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




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux