All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH v4 00/26] Fix some doc build warnings/errors and broken links
@ 2018-06-15 16:30 ` Mauro Carvalho Chehab
  0 siblings, 0 replies; 129+ messages in thread
From: Mauro Carvalho Chehab @ 2018-06-15 16:30 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Matthias Brugger, linux-arm-kernel, linux-mediatek


That's the 4th interaction of this patch series. The changes from
v3 are:

 - dropped "[PATCH v3 21/27] MAINTAINERS: get rid of non-existing Documentation/fpga"
   as per Alan Tull's request;
 - Changed the replacement at kernel/power/main.c per Rafael's request:
   Documentation/power/states.txt -> Documentation/admin-guide/pm/sleep-states.rst
 - Fixed a trivial merge conflict bad resolution with made MAINTAINERS
   to be touched on a patch that were supposed to touch only the script.
 - Added received acks/reviews.

Jon,

As discussed during the review of v2, your plans were to merge
things with potential to conflict with merges by the end of the
merge window. So, I'm resubmitting it in order to help you with
that.

This patch series is at my experimental tree:
	https://git.linuxtv.org/mchehab/experimental.git/log/?h=broken-links-v6

	git://linuxtv.org/mchehab/experimental.git broken-links-v6

They're based on the top of latest upstream patch:
	4c5e8fc62d6a (linus/master, docs/master) Merge tag 'linux-kselftest-4.18-rc1-2' of git://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest

This series contains:

- 5 patches that weren't applied on my previous v2 series yet. 
  Except for rebasing, the only change is that tools/memory-model/README
  was removed from patch 5, as per Andrea review;

- 4 patches for media stuff. I forgot to apply those via my tree.
  Only noticed I didn't apply on media when I rebased by work.

  Jon, 
    I could sent them via my tree, but, IMHO, better to apply together
    with the other ones. So, feel free to send them via your tree.

- 6 patches improving the scripts/documentation-file-ref-check tool.
  They fix a few things there and add more auto-correct rules,
  some focused at DT binding stuff.

- a series of other patches fixing several broken Documentation/
  file references.

After this patch series, only 33 broken references to doc files are detected:

    Documentation/devicetree/bindings/input/mtk-pmic-keys.txt: Documentation/devicetree/bindings/input/keys.txt
    Documentation/devicetree/bindings/input/mtk-pmic-keys.txt: Documentation/devicetree/bindings/input/keys.txt
    Documentation/devicetree/bindings/leds/common.txt: Documentation/devicetree/bindings/gpio/led.txt
    Documentation/devicetree/bindings/regulator/rohm,bd71837-regulator.txt: Documentation/devicetree/bindings/mfd/rohm,bd71837-pmic.txt
    Documentation/devicetree/dynamic-resolution-notes.txt: Documentation/devicetree/dt-object-internal.txt
    Documentation/scheduler/sched-pelt.c: Documentation/scheduler/sched-pelt
    Documentation/scsi/scsi_mid_low_api.txt: Documentation/Configure.help
    Documentation/sound/alsa-configuration.rst: Documentation/sound/oss/MultiSound
    Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000
    Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000
    Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/tcm_nab5000_base.h
    Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../include/target/target_core_fabric_ops.h
    Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/tcm_nab5000_fabric.c
    Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/tcm_nab5000_fabric.h
    Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/tcm_nab5000_configfs.c
    Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/Kbuild
    Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/Kconfig
    Documentation/trace/ftrace.rst: Documentation/trace/histogram.rst
    Documentation/translations/zh_CN/HOWTO: Documentation/DocBook/
    Documentation/translations/zh_CN/basic_profiling.txt: Documentation/basic_profiling
    Documentation/translations/zh_CN/basic_profiling.txt: Documentation/basic_profiling
    Documentation/translations/zh_CN/oops-tracing.txt: Documentation/admin-guide/oops-tracing.rst
    Documentation/translations/zh_CN/oops-tracing.txt: Documentation/admin-guide/oops-tracing.rst
    MAINTAINERS: Documentation/fpga/
    MAINTAINERS: Documentation/devicetree/bindings/i2c/ina209.txt
    MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
    arch/powerpc/Kconfig: Documentation/vm/protection-keys.rst
    drivers/isdn/mISDN/dsp_core.c: Documentation/isdn/mISDN.cert
    drivers/scsi/Kconfig: file:Documentation/scsi/tmscsim.txt
    drivers/vhost/vhost.c: Documentation/virtual/lguest/lguest.c
    include/linux/gpio.h: Documentation/gpio/gpio-legacy.txt
    kernel/sched/sched-pelt.h: Documentation/scheduler/sched-pelt
    sound/isa/Kconfig: file:Documentation/sound/oss/MultiSound

Mauro Carvalho Chehab (26):
  docs: can.rst: fix a footnote reference
  docs: crypto_engine.rst: Fix two parse warnings
  arch/*: Kconfig: fix documentation for NMI watchdog
  docs: fix broken references with multiple hints
  docs: Fix some broken references
  media: dvb: fix location of get_dvb_firmware script
  media: dvb: point to the location of the old README.dvb-usb file
  media: v4l: fix broken video4linux docs locations
  media: max2175: fix location of driver's companion documentation
  scripts/documentation-file-ref-check: fix help message
  scripts/documentation-file-ref-check: accept more wildcards at
    filenames
  scripts/documentation-file-ref-check: add a fix logic for DT
  scripts/documentation-file-ref-check: hint: dash or underline
  scripts/documentation-file-ref-check: get rid of false-positives
  scripts/documentation-file-ref-check: check tools/*/Documentation
  docs: Fix more broken references
  bindings: nvmem/zii: Fix location of nvmem.txt
  kernel-parameters.txt: fix pointers to sound parameters
  MAINTAINERS: fix location of some display DT bindings
  MAINTAINERS: fix location of DT npcm files
  devicetree: fix some bindings file names
  devicetree: fix name of pinctrl-bindings.txt
  devicetree: fix a series of wrong file references
  ABI: sysfs-devices-system-cpu: remove a broken reference
  Documentation: rstFlatTable.py: fix a broken reference
  fix a series of Documentation/ broken file name references

 Documentation/ABI/obsolete/sysfs-gpio         |  2 +-
 .../ABI/testing/sysfs-devices-system-cpu      |  3 -
 .../admin-guide/kernel-parameters.txt         |  9 +--
 Documentation/crypto/crypto_engine.rst        |  8 ++-
 .../bindings/clock/st/st,clkgen.txt           |  8 +--
 .../devicetree/bindings/clock/ti/gate.txt     |  2 +-
 .../bindings/clock/ti/interface.txt           |  2 +-
 .../bindings/cpufreq/cpufreq-mediatek.txt     |  2 +-
 .../bindings/devfreq/rk3399_dmc.txt           |  2 +-
 .../bindings/display/bridge/tda998x.txt       |  2 +-
 .../bindings/gpu/arm,mali-midgard.txt         |  2 +-
 .../bindings/gpu/arm,mali-utgard.txt          |  2 +-
 .../bindings/input/rmi4/rmi_2d_sensor.txt     |  2 +-
 .../bindings/input/rotary-encoder.txt         |  2 +-
 .../bindings/media/stih407-c8sectpfe.txt      |  2 +-
 .../devicetree/bindings/mfd/as3722.txt        |  2 +-
 .../devicetree/bindings/mfd/mt6397.txt        |  2 +-
 .../devicetree/bindings/mfd/sun6i-prcm.txt    |  4 +-
 .../bindings/mmc/exynos-dw-mshc.txt           |  2 +-
 .../bindings/mmc/microchip,sdhci-pic32.txt    |  2 +-
 .../devicetree/bindings/mmc/sdhci-st.txt      |  2 +-
 .../devicetree/bindings/net/dsa/ksz.txt       |  2 +-
 .../devicetree/bindings/net/dsa/mt7530.txt    |  2 +-
 .../bindings/nvmem/zii,rave-sp-eeprom.txt     |  2 +-
 .../bindings/pci/hisilicon-pcie.txt           |  2 +-
 .../devicetree/bindings/pci/kirin-pcie.txt    |  2 +-
 .../devicetree/bindings/pci/pci-keystone.txt  |  4 +-
 .../bindings/pinctrl/pinctrl-max77620.txt     |  4 +-
 .../bindings/pinctrl/pinctrl-mcp23s08.txt     |  4 +-
 .../bindings/pinctrl/pinctrl-rk805.txt        |  4 +-
 .../devicetree/bindings/power/fsl,imx-gpc.txt |  2 +-
 .../bindings/power/supply/ab8500/btemp.txt    |  2 +-
 .../bindings/power/supply/ab8500/chargalg.txt |  2 +-
 .../bindings/power/supply/ab8500/charger.txt  |  2 +-
 .../bindings/power/wakeup-source.txt          |  2 +-
 .../bindings/serial/microchip,pic32-uart.txt  |  2 +-
 .../bindings/sound/st,stm32-i2s.txt           |  2 +-
 .../bindings/sound/st,stm32-sai.txt           |  2 +-
 .../devicetree/bindings/spi/spi-st-ssc.txt    |  2 +-
 .../devicetree/bindings/usb/rockchip,dwc3.txt |  2 +-
 Documentation/driver-api/gpio/consumer.rst    |  2 +-
 Documentation/hwmon/ina2xx                    |  2 +-
 Documentation/kprobes.txt                     |  4 +-
 Documentation/maintainer/pull-requests.rst    |  2 +-
 Documentation/networking/can.rst              |  4 +-
 Documentation/sphinx/rstFlatTable.py          |  2 -
 Documentation/trace/coresight.txt             |  2 +-
 Documentation/trace/events.rst                |  2 +-
 Documentation/trace/ftrace-uses.rst           |  2 +-
 Documentation/trace/histogram.txt             |  2 +-
 Documentation/trace/intel_th.rst              |  2 +-
 Documentation/trace/tracepoint-analysis.rst   |  8 +--
 Documentation/translations/ja_JP/howto.rst    |  4 +-
 Documentation/translations/ko_KR/howto.rst    |  2 +-
 .../translations/zh_CN/SubmittingDrivers      |  2 +-
 Documentation/translations/zh_CN/gpio.txt     |  4 +-
 .../translations/zh_CN/io_ordering.txt        |  2 +-
 .../translations/zh_CN/magic-number.txt       |  4 +-
 .../zh_CN/video4linux/omap3isp.txt            |  4 +-
 .../zh_CN/video4linux/v4l2-framework.txt      |  6 +-
 MAINTAINERS                                   | 62 +++++++++----------
 arch/Kconfig                                  |  2 +-
 arch/arm/Kconfig                              |  2 +-
 arch/arm/include/asm/cacheflush.h             |  2 +-
 arch/arm64/include/asm/cacheflush.h           |  2 +-
 arch/microblaze/include/asm/cacheflush.h      |  2 +-
 arch/parisc/Kconfig                           |  2 +-
 arch/sh/Kconfig                               |  2 +-
 arch/sparc/Kconfig                            |  2 +-
 arch/um/Kconfig.um                            |  2 +-
 arch/unicore32/include/asm/cacheflush.h       |  2 +-
 arch/x86/entry/vsyscall/vsyscall_64.c         |  2 +-
 arch/xtensa/include/asm/cacheflush.h          |  4 +-
 block/Kconfig                                 |  2 +-
 certs/Kconfig                                 |  2 +-
 crypto/asymmetric_keys/asymmetric_type.c      |  2 +-
 crypto/asymmetric_keys/signature.c            |  2 +-
 drivers/char/Kconfig                          |  2 +-
 drivers/clk/clk.c                             |  4 +-
 drivers/clk/ingenic/cgu.h                     |  2 +-
 drivers/dma/dmaengine.c                       |  2 +-
 drivers/gpu/vga/Kconfig                       |  2 +-
 drivers/gpu/vga/vgaarb.c                      |  2 +-
 drivers/hid/usbhid/Kconfig                    |  2 +-
 drivers/input/Kconfig                         |  4 +-
 drivers/input/joystick/Kconfig                | 14 ++---
 drivers/input/joystick/iforce/Kconfig         |  4 +-
 drivers/input/joystick/walkera0701.c          |  2 +-
 drivers/input/misc/Kconfig                    |  4 +-
 drivers/input/misc/rotary_encoder.c           |  2 +-
 drivers/input/mouse/Kconfig                   |  6 +-
 drivers/input/mouse/alps.c                    |  2 +-
 drivers/input/serio/Kconfig                   |  4 +-
 drivers/input/touchscreen/wm97xx-core.c       |  2 +-
 drivers/lightnvm/pblk-rb.c                    |  2 +-
 drivers/md/bcache/Kconfig                     |  2 +-
 drivers/md/bcache/btree.c                     |  2 +-
 drivers/md/bcache/extents.c                   |  2 +-
 drivers/media/dvb-core/dvb_ringbuffer.c       |  2 +-
 drivers/media/dvb-frontends/Kconfig           | 18 +++---
 drivers/media/dvb-frontends/dib3000.h         |  2 +-
 drivers/media/dvb-frontends/dib3000mb.c       |  2 +-
 drivers/media/dvb-frontends/eds1547.h         |  2 +-
 drivers/media/dvb-frontends/nxt200x.c         |  4 +-
 drivers/media/dvb-frontends/or51211.c         |  2 +-
 drivers/media/dvb-frontends/sp8870.c          |  2 +-
 drivers/media/dvb-frontends/sp887x.c          |  2 +-
 drivers/media/dvb-frontends/tda1004x.c        |  4 +-
 drivers/media/dvb-frontends/tda10071.c        |  2 +-
 drivers/media/dvb-frontends/z0194a.h          |  2 +-
 drivers/media/i2c/max2175.c                   |  6 +-
 drivers/media/pci/bt8xx/Kconfig               |  2 +-
 drivers/media/pci/cx18/cx18-dvb.c             |  2 +-
 drivers/media/pci/cx18/cx18-streams.c         |  4 +-
 drivers/media/pci/cx23885/cx23885-cards.c     |  2 +-
 drivers/media/pci/meye/Kconfig                |  2 +-
 drivers/media/pci/ttpci/Kconfig               |  2 +-
 drivers/media/platform/pxa_camera.c           |  4 +-
 .../soc_camera/sh_mobile_ceu_camera.c         |  2 +-
 drivers/media/radio/Kconfig                   | 12 ++--
 drivers/media/radio/si470x/Kconfig            |  2 +-
 drivers/media/radio/wl128x/Kconfig            |  2 +-
 drivers/media/usb/dvb-usb-v2/Kconfig          |  2 +-
 drivers/media/usb/dvb-usb-v2/dvb_usb_core.c   |  2 +-
 drivers/media/usb/dvb-usb-v2/gl861.c          |  2 +-
 drivers/media/usb/dvb-usb-v2/lmedm04.c        |  4 +-
 drivers/media/usb/dvb-usb-v2/lmedm04.h        |  2 +-
 drivers/media/usb/dvb-usb-v2/mxl111sf.c       |  2 +-
 drivers/media/usb/dvb-usb-v2/mxl111sf.h       |  2 +-
 drivers/media/usb/dvb-usb/Kconfig             |  2 +-
 drivers/media/usb/dvb-usb/a800.c              |  2 +-
 drivers/media/usb/dvb-usb/af9005-fe.c         |  2 +-
 drivers/media/usb/dvb-usb/af9005-remote.c     |  2 +-
 drivers/media/usb/dvb-usb/af9005.c            |  2 +-
 drivers/media/usb/dvb-usb/af9005.h            |  2 +-
 drivers/media/usb/dvb-usb/az6027.c            |  2 +-
 drivers/media/usb/dvb-usb/cxusb.c             |  2 +-
 drivers/media/usb/dvb-usb/dibusb-common.c     |  2 +-
 drivers/media/usb/dvb-usb/dibusb-mb.c         |  2 +-
 drivers/media/usb/dvb-usb/dibusb-mc-common.c  |  2 +-
 drivers/media/usb/dvb-usb/dibusb-mc.c         |  2 +-
 drivers/media/usb/dvb-usb/dibusb.h            |  2 +-
 drivers/media/usb/dvb-usb/digitv.c            |  2 +-
 drivers/media/usb/dvb-usb/dtt200u-fe.c        |  2 +-
 drivers/media/usb/dvb-usb/dtt200u.c           |  2 +-
 drivers/media/usb/dvb-usb/dtt200u.h           |  2 +-
 drivers/media/usb/dvb-usb/dvb-usb-firmware.c  |  2 +-
 drivers/media/usb/dvb-usb/dvb-usb-init.c      |  2 +-
 drivers/media/usb/dvb-usb/dw2102.c            |  6 +-
 drivers/media/usb/dvb-usb/friio-fe.c          |  2 +-
 drivers/media/usb/dvb-usb/friio.c             |  2 +-
 drivers/media/usb/dvb-usb/friio.h             |  2 +-
 drivers/media/usb/dvb-usb/gp8psk.c            |  4 +-
 drivers/media/usb/dvb-usb/gp8psk.h            |  2 +-
 drivers/media/usb/dvb-usb/m920x.c             |  2 +-
 drivers/media/usb/dvb-usb/nova-t-usb2.c       |  2 +-
 drivers/media/usb/dvb-usb/opera1.c            |  4 +-
 drivers/media/usb/dvb-usb/ttusb2.c            |  2 +-
 drivers/media/usb/dvb-usb/ttusb2.h            |  2 +-
 drivers/media/usb/dvb-usb/umt-010.c           |  2 +-
 drivers/media/usb/dvb-usb/vp702x-fe.c         |  2 +-
 drivers/media/usb/dvb-usb/vp702x.c            |  2 +-
 drivers/media/usb/dvb-usb/vp7045-fe.c         |  2 +-
 drivers/media/usb/dvb-usb/vp7045.c            |  2 +-
 drivers/media/usb/dvb-usb/vp7045.h            |  2 +-
 drivers/media/usb/gspca/m5602/Kconfig         |  2 -
 drivers/media/usb/ttusb-dec/Kconfig           |  6 +-
 drivers/media/usb/zr364xx/Kconfig             |  2 +-
 drivers/net/ethernet/intel/Kconfig            |  8 +--
 drivers/parport/Kconfig                       |  6 +-
 drivers/platform/x86/Kconfig                  |  2 +-
 drivers/sbus/char/oradax.c                    |  2 +-
 drivers/soundwire/stream.c                    |  8 +--
 .../staging/fsl-mc/bus/dpio/dpio-driver.txt   |  2 +-
 drivers/staging/media/bcm2048/TODO            |  2 +-
 drivers/staging/media/zoran/Kconfig           |  2 +-
 drivers/video/fbdev/skeletonfb.c              |  8 +--
 fs/Kconfig.binfmt                             |  2 +-
 fs/befs/ChangeLog                             |  2 +-
 fs/binfmt_misc.c                              |  2 +-
 fs/orangefs/orangefs-sysfs.c                  |  2 +-
 include/keys/asymmetric-subtype.h             |  2 +-
 include/keys/asymmetric-type.h                |  2 +-
 include/linux/assoc_array.h                   |  2 +-
 include/linux/assoc_array_priv.h              |  2 +-
 include/linux/circ_buf.h                      |  2 +-
 include/linux/ftrace.h                        |  2 +-
 include/linux/platform_data/sc18is602.h       |  2 +-
 include/linux/rculist_nulls.h                 |  2 +-
 include/linux/tracepoint.h                    |  2 +-
 include/uapi/linux/prctl.h                    |  2 +-
 include/xen/interface/io/kbdif.h              |  2 +-
 kernel/cgroup/cpuset.c                        |  2 +-
 kernel/power/main.c                           |  5 +-
 kernel/trace/Kconfig                          | 16 ++---
 lib/Kconfig                                   |  2 +-
 scripts/documentation-file-ref-check          | 56 ++++++++++++++---
 security/device_cgroup.c                      |  2 +-
 security/selinux/hooks.c                      |  2 +-
 sound/core/Kconfig                            |  4 +-
 sound/drivers/Kconfig                         |  4 +-
 sound/pci/Kconfig                             | 10 +--
 tools/include/uapi/linux/prctl.h              |  2 +-
 tools/lib/api/fs/fs.c                         |  2 +-
 tools/perf/util/bpf-prologue.c                |  2 +-
 .../config/custom-timeline-functions.cfg      |  4 +-
 206 files changed, 372 insertions(+), 339 deletions(-)

-- 
2.17.1


^ permalink raw reply	[flat|nested] 129+ messages in thread
* [v4,26/26] fix a series of Documentation/ broken file name references
  2018-06-15 16:30 ` Mauro Carvalho Chehab
                   ` (2 preceding siblings ...)
  (?)
@ 2018-06-15 16:30 ` Mauro Carvalho Chehab
  -1 siblings, 0 replies; 129+ messages in thread
From: Mauro Carvalho Chehab @ 2018-06-15 16:30 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Harry Wei, Vinod Koul, Dan Williams, Darren Hart,
	Andy Shevchenko, David S. Miller, Luis de Bethencourt,
	Salah Triki, Mike Marshall, Martin Brandenburg,
	Rafael J. Wysocki, Pavel Machek, Len Brown, linux-kernel,
	dmaengine, platform-driver-x86, sparclinux, devel, linux-pm

As files move around, their previous links break. Fix the
references for them.

Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/translations/zh_CN/io_ordering.txt | 2 +-
 drivers/dma/dmaengine.c                          | 2 +-
 drivers/platform/x86/Kconfig                     | 2 +-
 drivers/sbus/char/oradax.c                       | 2 +-
 fs/befs/ChangeLog                                | 2 +-
 fs/orangefs/orangefs-sysfs.c                     | 2 +-
 include/linux/platform_data/sc18is602.h          | 2 +-
 kernel/power/main.c                              | 5 +++--
 8 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/Documentation/translations/zh_CN/io_ordering.txt b/Documentation/translations/zh_CN/io_ordering.txt
index e592daf4e014..1f8127bdd415 100644
--- a/Documentation/translations/zh_CN/io_ordering.txt
+++ b/Documentation/translations/zh_CN/io_ordering.txt
@@ -1,4 +1,4 @@
-Chinese translated version of Documentation/io_orderings.txt
+Chinese translated version of Documentation/io_ordering.txt
 
 If you have any comment or update to the content, please contact the
 original document maintainer directly.  However, if you have a problem
diff --git a/drivers/dma/dmaengine.c b/drivers/dma/dmaengine.c
index b451354735d3..08ba8473a284 100644
--- a/drivers/dma/dmaengine.c
+++ b/drivers/dma/dmaengine.c
@@ -38,7 +38,7 @@
  * Each device has a channels list, which runs unlocked but is never modified
  * once the device is registered, it's just setup by the driver.
  *
- * See Documentation/dmaengine.txt for more details
+ * See Documentation/driver-api/dmaengine for more details
  */
 
 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
index f27cb186437d..ac4d48830415 100644
--- a/drivers/platform/x86/Kconfig
+++ b/drivers/platform/x86/Kconfig
@@ -1052,7 +1052,7 @@ config SAMSUNG_LAPTOP
 	  function keys, wireless LED, LCD backlight level.
 
 	  It may also provide some sysfs files described in
-	  <file:Documentation/ABI/testing/sysfs-platform-samsung-laptop>
+	  <file:Documentation/ABI/testing/sysfs-driver-samsung-laptop>
 
 	  To compile this driver as a module, choose M here: the module
 	  will be called samsung-laptop.
diff --git a/drivers/sbus/char/oradax.c b/drivers/sbus/char/oradax.c
index 1754f55e2fac..524f9ea62e52 100644
--- a/drivers/sbus/char/oradax.c
+++ b/drivers/sbus/char/oradax.c
@@ -30,7 +30,7 @@
  * the recommended way for applications to use the coprocessor, and
  * the driver interface is not intended for general use.
  *
- * See Documentation/sparc/oradax/oracle_dax.txt for more details.
+ * See Documentation/sparc/oradax/oracle-dax.txt for more details.
  */
 
 #include <linux/uaccess.h>
diff --git a/fs/befs/ChangeLog b/fs/befs/ChangeLog
index 16f2dfe8c2f7..aff7eec8f327 100644
--- a/fs/befs/ChangeLog
+++ b/fs/befs/ChangeLog
@@ -389,7 +389,7 @@ Version 0.4 (2001-10-28)
 	(fs/nls/Config.in)
 
 * Added Configure.help entries for CONFIG_BEFS_FS and CONFIG_DEBUG_BEFS
-	(Documentation/Configure.help)
+	(currently at fs/befs/Kconfig)
 
 2001-08-??
 ==========
diff --git a/fs/orangefs/orangefs-sysfs.c b/fs/orangefs/orangefs-sysfs.c
index 079a465796f3..dd28079f518c 100644
--- a/fs/orangefs/orangefs-sysfs.c
+++ b/fs/orangefs/orangefs-sysfs.c
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0
 /*
- * Documentation/ABI/stable/orangefs-sysfs:
+ * Documentation/ABI/stable/sysfs-fs-orangefs:
  *
  * What:		/sys/fs/orangefs/perf_counter_reset
  * Date:		June 2015
diff --git a/include/linux/platform_data/sc18is602.h b/include/linux/platform_data/sc18is602.h
index 997b06634152..18602cab7799 100644
--- a/include/linux/platform_data/sc18is602.h
+++ b/include/linux/platform_data/sc18is602.h
@@ -7,7 +7,7 @@
  * it under the terms of the GNU General Public License version 2 as
  * published by the Free Software Foundation.
  *
- * For further information, see the Documentation/spi/sc18is602 file.
+ * For further information, see the Documentation/spi/spi-sc18is602 file.
  */
 
 /**
diff --git a/kernel/power/main.c b/kernel/power/main.c
index 705c2366dafe..d9706da10930 100644
--- a/kernel/power/main.c
+++ b/kernel/power/main.c
@@ -455,8 +455,9 @@ struct kobject *power_kobj;
  * state - control system sleep states.
  *
  * show() returns available sleep state labels, which may be "mem", "standby",
- * "freeze" and "disk" (hibernation).  See Documentation/power/states.txt for a
- * description of what they mean.
+ * "freeze" and "disk" (hibernation).
+ * See Documentation/admin-guide/pm/sleep-states.rst for a description of
+ * what they mean.
  *
  * store() accepts one of those strings, translates it into the proper
  * enumerated value, and initiates a suspend transition.

^ permalink raw reply related	[flat|nested] 129+ messages in thread
* [v4,26/26] fix a series of Documentation/ broken file name references
  2018-06-15 16:30 ` Mauro Carvalho Chehab
                   ` (2 preceding siblings ...)
  (?)
@ 2018-06-16 15:52 ` Rafael J. Wysocki
  -1 siblings, 0 replies; 129+ messages in thread
From: Rafael J. Wysocki @ 2018-06-16 15:52 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Jonathan Corbet, Mauro Carvalho Chehab,
	Linux Kernel Mailing List, Harry Wei, Vinod Koul, Dan Williams,
	Darren Hart, Andy Shevchenko, David S. Miller,
	Luis de Bethencourt, Salah Triki, Mike Marshall,
	Martin Brandenburg, Rafael J. Wysocki, Pavel Machek, Len Brown,
	linux-kernel, dmaengine, Platform Driver, sparclinux, devel,
	Linux PM

On Fri, Jun 15, 2018 at 6:30 PM, Mauro Carvalho Chehab
<mchehab+samsung@kernel.org> wrote:
> As files move around, their previous links break. Fix the
> references for them.
>
> Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
>  Documentation/translations/zh_CN/io_ordering.txt | 2 +-
>  drivers/dma/dmaengine.c                          | 2 +-
>  drivers/platform/x86/Kconfig                     | 2 +-
>  drivers/sbus/char/oradax.c                       | 2 +-
>  fs/befs/ChangeLog                                | 2 +-
>  fs/orangefs/orangefs-sysfs.c                     | 2 +-
>  include/linux/platform_data/sc18is602.h          | 2 +-
>  kernel/power/main.c                              | 5 +++--
>  8 files changed, 10 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/translations/zh_CN/io_ordering.txt b/Documentation/translations/zh_CN/io_ordering.txt
> index e592daf4e014..1f8127bdd415 100644
> --- a/Documentation/translations/zh_CN/io_ordering.txt
> +++ b/Documentation/translations/zh_CN/io_ordering.txt
> @@ -1,4 +1,4 @@
> -Chinese translated version of Documentation/io_orderings.txt
> +Chinese translated version of Documentation/io_ordering.txt
>
>  If you have any comment or update to the content, please contact the
>  original document maintainer directly.  However, if you have a problem
> diff --git a/drivers/dma/dmaengine.c b/drivers/dma/dmaengine.c
> index b451354735d3..08ba8473a284 100644
> --- a/drivers/dma/dmaengine.c
> +++ b/drivers/dma/dmaengine.c
> @@ -38,7 +38,7 @@
>   * Each device has a channels list, which runs unlocked but is never modified
>   * once the device is registered, it's just setup by the driver.
>   *
> - * See Documentation/dmaengine.txt for more details
> + * See Documentation/driver-api/dmaengine for more details
>   */
>
>  #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
> diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
> index f27cb186437d..ac4d48830415 100644
> --- a/drivers/platform/x86/Kconfig
> +++ b/drivers/platform/x86/Kconfig
> @@ -1052,7 +1052,7 @@ config SAMSUNG_LAPTOP
>           function keys, wireless LED, LCD backlight level.
>
>           It may also provide some sysfs files described in
> -         <file:Documentation/ABI/testing/sysfs-platform-samsung-laptop>
> +         <file:Documentation/ABI/testing/sysfs-driver-samsung-laptop>
>
>           To compile this driver as a module, choose M here: the module
>           will be called samsung-laptop.
> diff --git a/drivers/sbus/char/oradax.c b/drivers/sbus/char/oradax.c
> index 1754f55e2fac..524f9ea62e52 100644
> --- a/drivers/sbus/char/oradax.c
> +++ b/drivers/sbus/char/oradax.c
> @@ -30,7 +30,7 @@
>   * the recommended way for applications to use the coprocessor, and
>   * the driver interface is not intended for general use.
>   *
> - * See Documentation/sparc/oradax/oracle_dax.txt for more details.
> + * See Documentation/sparc/oradax/oracle-dax.txt for more details.
>   */
>
>  #include <linux/uaccess.h>
> diff --git a/fs/befs/ChangeLog b/fs/befs/ChangeLog
> index 16f2dfe8c2f7..aff7eec8f327 100644
> --- a/fs/befs/ChangeLog
> +++ b/fs/befs/ChangeLog
> @@ -389,7 +389,7 @@ Version 0.4 (2001-10-28)
>         (fs/nls/Config.in)
>
>  * Added Configure.help entries for CONFIG_BEFS_FS and CONFIG_DEBUG_BEFS
> -       (Documentation/Configure.help)
> +       (currently at fs/befs/Kconfig)
>
>  2001-08-??
>  ==========
> diff --git a/fs/orangefs/orangefs-sysfs.c b/fs/orangefs/orangefs-sysfs.c
> index 079a465796f3..dd28079f518c 100644
> --- a/fs/orangefs/orangefs-sysfs.c
> +++ b/fs/orangefs/orangefs-sysfs.c
> @@ -1,6 +1,6 @@
>  // SPDX-License-Identifier: GPL-2.0
>  /*
> - * Documentation/ABI/stable/orangefs-sysfs:
> + * Documentation/ABI/stable/sysfs-fs-orangefs:
>   *
>   * What:               /sys/fs/orangefs/perf_counter_reset
>   * Date:               June 2015
> diff --git a/include/linux/platform_data/sc18is602.h b/include/linux/platform_data/sc18is602.h
> index 997b06634152..18602cab7799 100644
> --- a/include/linux/platform_data/sc18is602.h
> +++ b/include/linux/platform_data/sc18is602.h
> @@ -7,7 +7,7 @@
>   * it under the terms of the GNU General Public License version 2 as
>   * published by the Free Software Foundation.
>   *
> - * For further information, see the Documentation/spi/sc18is602 file.
> + * For further information, see the Documentation/spi/spi-sc18is602 file.
>   */
>
>  /**
> diff --git a/kernel/power/main.c b/kernel/power/main.c
> index 705c2366dafe..d9706da10930 100644
> --- a/kernel/power/main.c
> +++ b/kernel/power/main.c
> @@ -455,8 +455,9 @@ struct kobject *power_kobj;
>   * state - control system sleep states.
>   *
>   * show() returns available sleep state labels, which may be "mem", "standby",
> - * "freeze" and "disk" (hibernation).  See Documentation/power/states.txt for a
> - * description of what they mean.
> + * "freeze" and "disk" (hibernation).
> + * See Documentation/admin-guide/pm/sleep-states.rst for a description of
> + * what they mean.

Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

for the PM part above.

>   *
>   * store() accepts one of those strings, translates it into the proper
>   * enumerated value, and initiates a suspend transition.
> --
---
To unsubscribe from this list: send the line "unsubscribe dmaengine" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

^ permalink raw reply	[flat|nested] 129+ messages in thread
* [v4,26/26] fix a series of Documentation/ broken file name references
  2018-06-15 16:30 ` Mauro Carvalho Chehab
                   ` (2 preceding siblings ...)
  (?)
@ 2018-06-19  4:14 ` Vinod
  -1 siblings, 0 replies; 129+ messages in thread
From: Vinod Koul @ 2018-06-19  4:14 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Jonathan Corbet, Mauro Carvalho Chehab,
	linux-kernel, Harry Wei, Dan Williams, Darren Hart,
	Andy Shevchenko, David S. Miller, Luis de Bethencourt,
	Salah Triki, Mike Marshall, Martin Brandenburg,
	Rafael J. Wysocki, Pavel Machek, Len Brown, linux-kernel,
	dmaengine, platform-driver-x86, sparclinux, devel, linux-pm

On 15-06-18, 13:30, Mauro Carvalho Chehab wrote:

>  If you have any comment or update to the content, please contact the
>  original document maintainer directly.  However, if you have a problem
> diff --git a/drivers/dma/dmaengine.c b/drivers/dma/dmaengine.c
> index b451354735d3..08ba8473a284 100644
> --- a/drivers/dma/dmaengine.c
> +++ b/drivers/dma/dmaengine.c
> @@ -38,7 +38,7 @@
>   * Each device has a channels list, which runs unlocked but is never modified
>   * once the device is registered, it's just setup by the driver.
>   *
> - * See Documentation/dmaengine.txt for more details
> + * See Documentation/driver-api/dmaengine for more details

DMAengine part:

Acked-by: Vinod Koul <vkoul@kernel.org>

^ permalink raw reply	[flat|nested] 129+ messages in thread
end of thread, other threads:[~2018-08-07  7:05 UTC | newest]

Thread overview: 129+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-06-15 16:30 [PATCH v4 00/26] Fix some doc build warnings/errors and broken links Mauro Carvalho Chehab
2018-06-15 16:30 ` Mauro Carvalho Chehab
2018-06-15 16:30 ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 01/26] docs: can.rst: fix a footnote reference Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 02/26] docs: crypto_engine.rst: Fix two parse warnings Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 03/26] arch/*: Kconfig: fix documentation for NMI watchdog Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 04/26] docs: fix broken references with multiple hints Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30   ` [v4,04/26] " Mauro Carvalho Chehab
2018-06-15 16:30   ` [PATCH v4 04/26] " Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 18:22   ` James Morris
2018-06-15 18:22     ` James Morris
2018-06-15 18:22     ` James Morris
2018-06-15 18:22     ` [v4,04/26] " James Morris
2018-06-15 18:22     ` [PATCH v4 04/26] " James Morris
2018-06-15 18:22     ` James Morris
2018-06-20 15:26   ` Rob Herring
2018-06-20 15:26     ` Rob Herring
2018-06-20 15:26     ` Rob Herring
2018-06-20 15:26     ` [v4,04/26] " Rob Herring
2018-06-20 15:26     ` [PATCH v4 04/26] " Rob Herring
2018-06-20 15:26     ` Rob Herring
2018-06-15 16:30 ` [PATCH v4 05/26] docs: Fix some broken references Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30   ` [v4,05/26] " Mauro Carvalho Chehab
2018-06-15 16:30   ` [PATCH v4 05/26] " Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 06/26] media: dvb: fix location of get_dvb_firmware script Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 07/26] media: dvb: point to the location of the old README.dvb-usb file Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 08/26] media: v4l: fix broken video4linux docs locations Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 09/26] media: max2175: fix location of driver's companion documentation Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:34   ` Ramesh Shanmugasundaram
2018-06-15 16:34     ` Ramesh Shanmugasundaram
2018-06-15 16:30 ` [PATCH v4 10/26] scripts/documentation-file-ref-check: fix help message Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 11/26] scripts/documentation-file-ref-check: accept more wildcards at filenames Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 12/26] scripts/documentation-file-ref-check: add a fix logic for DT Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 13/26] scripts/documentation-file-ref-check: hint: dash or underline Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 14/26] scripts/documentation-file-ref-check: get rid of false-positives Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 15/26] scripts/documentation-file-ref-check: check tools/*/Documentation Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 16/26] docs: Fix more broken references Mauro Carvalho Chehab
2018-06-15 16:30   ` [Intel-wired-lan] " Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30   ` [v4,16/26] " Mauro Carvalho Chehab
2018-06-15 16:30   ` [PATCH v4 16/26] " Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:41   ` Miguel Ojeda
2018-06-15 16:41     ` [Intel-wired-lan] " Miguel Ojeda
2018-06-15 16:41     ` Miguel Ojeda
2018-06-15 16:41     ` [v4,16/26] " Miguel Ojeda
2018-06-15 16:41     ` [PATCH v4 16/26] " Miguel Ojeda
2018-06-15 16:41     ` Miguel Ojeda
2018-06-15 16:30 ` [PATCH v4 17/26] bindings: nvmem/zii: Fix location of nvmem.txt Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 18/26] kernel-parameters.txt: fix pointers to sound parameters Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 19/26] MAINTAINERS: fix location of some display DT bindings Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 23:38   ` Eric Anholt
2018-06-15 16:30 ` [PATCH v4 20/26] MAINTAINERS: fix location of DT npcm files Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 21/26] devicetree: fix some bindings file names Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 22/26] devicetree: fix name of pinctrl-bindings.txt Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-18  5:48   ` Lee Jones
2018-06-18  5:48     ` Lee Jones
2018-06-15 16:30 ` [PATCH v4 23/26] devicetree: fix a series of wrong file references Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-18  5:49   ` Lee Jones
2018-06-18  5:49     ` Lee Jones
2018-06-18  5:49     ` Lee Jones
2018-06-18  5:49     ` Lee Jones
2018-06-18  5:49     ` Lee Jones
2018-06-28 13:53   ` Bjorn Helgaas
2018-06-28 13:53     ` Bjorn Helgaas
2018-06-28 13:53     ` Bjorn Helgaas
2018-06-28 13:53     ` Bjorn Helgaas
2018-06-28 13:53     ` Bjorn Helgaas
2018-08-07  7:04   ` Chen-Yu Tsai
2018-08-07  7:04     ` Chen-Yu Tsai
2018-08-07  7:04     ` Chen-Yu Tsai
2018-08-07  7:04     ` Chen-Yu Tsai
2018-06-15 16:30 ` [PATCH v4 24/26] ABI: sysfs-devices-system-cpu: remove a broken reference Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 25/26] Documentation: rstFlatTable.py: fix " Mauro Carvalho Chehab
2018-06-15 16:30   ` Mauro Carvalho Chehab
2018-06-15 19:09 ` [PATCH v4 00/26] Fix some doc build warnings/errors and broken links Jonathan Corbet
2018-06-15 19:09   ` Jonathan Corbet
2018-06-15 19:09   ` Jonathan Corbet
2018-06-15 20:52   ` Mauro Carvalho Chehab
2018-06-15 20:52     ` Mauro Carvalho Chehab
2018-06-15 20:52     ` Mauro Carvalho Chehab
2018-06-15 16:30 [v4,26/26] fix a series of Documentation/ broken file name references Mauro Carvalho Chehab
2018-06-15 16:30 ` [PATCH v4 26/26] " Mauro Carvalho Chehab
2018-06-15 16:30 ` Mauro Carvalho Chehab
2018-06-15 16:30 ` Mauro Carvalho Chehab
2018-06-15 16:30 ` Mauro Carvalho Chehab
2018-06-16 15:52 [v4,26/26] " Rafael J. Wysocki
2018-06-16 15:52 ` [PATCH v4 26/26] " Rafael J. Wysocki
2018-06-16 15:52 ` Rafael J. Wysocki
2018-06-16 15:52 ` Rafael J. Wysocki
2018-06-16 15:52 ` Rafael J. Wysocki
2018-06-19  4:14 [v4,26/26] " Vinod Koul
2018-06-19  4:26 ` [PATCH v4 26/26] " Vinod
2018-06-19  4:14 ` Vinod
2018-06-19  4:14 ` Vinod
2018-06-19  4:14 ` Vinod

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.