public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Tom Saeger <tom.saeger@oracle.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Tom Saeger <tom.saeger@oracle.com>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH 0/8] Documentation: fix invalid Documentation refs (1)
Date: Tue, 10 Oct 2017 12:35:58 -0500	[thread overview]
Message-ID: <cover.1507653969.git.tom.saeger@oracle.com> (raw)

Recently, while reading up on binfmt I attempted to open a document ref
only to find it was invalid.  I did a quick grep, found all the
binfmt_misc related broken refs and sent a patch.

Fine. Easy.

Then I wondered, "how many broken doc refs are there?".

Turns out with all the recent doc moves, quite a few.

I went about fixing just those found in Documentation/,
except those in Documentation/translations/ and
Documentation/devicetree/ for now.

Most of these changes were s/txt/rst/ or fixing up a path to an obvious
new location.  Some required going back to v4.10 v4.4 or some other
version to sleuth-out what content was actually being referenced and
then fixing the reference to point to the new file with that content.

This is batch 1.


Tom Saeger (8):
  Documentation: fix driver-api doc refs
  Documentation: fix admin-guide doc refs
  Documentation: fix input related doc refs
  Documentation: fix security related doc refs
  Documentation: fix media related doc refs
  Documentation: fix sound related doc refs
  Documentation: fix usb related doc refs
  Documentation: fix networking related doc refs.

 Documentation/ABI/stable/sysfs-devices                 |  2 +-
 Documentation/ABI/testing/evm                          |  4 ++--
 Documentation/ABI/testing/sysfs-devices-system-cpu     |  6 ++++--
 Documentation/ABI/testing/sysfs-power                  |  6 ++++--
 Documentation/admin-guide/README.rst                   |  2 +-
 Documentation/admin-guide/kernel-parameters.txt        | 18 +++++++++---------
 Documentation/admin-guide/reporting-bugs.rst           |  4 ++--
 Documentation/driver-api/usb/usb.rst                   |  4 +---
 Documentation/hid/hiddev.txt                           |  2 +-
 Documentation/input/devices/xpad.rst                   |  3 ++-
 Documentation/laptops/laptop-mode.txt                  |  6 +++---
 Documentation/media/dvb-drivers/bt8xx.rst              |  8 ++++----
 Documentation/media/uapi/v4l/dev-sliced-vbi.rst        |  2 +-
 Documentation/media/uapi/v4l/extended-controls.rst     |  2 +-
 Documentation/media/uapi/v4l/pixfmt-reserved.rst       |  2 +-
 Documentation/media/v4l-drivers/bttv.rst               |  2 +-
 Documentation/media/v4l-drivers/max2175.rst            |  2 +-
 Documentation/networking/cdc_mbim.txt                  |  4 ++--
 Documentation/networking/checksum-offloads.txt         |  2 +-
 Documentation/networking/packet_mmap.txt               |  2 +-
 Documentation/power/interface.txt                      |  3 ++-
 Documentation/power/pci.txt                            | 10 +++++-----
 Documentation/power/runtime_pm.txt                     |  2 +-
 Documentation/process/submitting-drivers.rst           |  2 +-
 Documentation/security/LSM.rst                         |  2 +-
 Documentation/security/credentials.rst                 |  2 +-
 Documentation/security/keys/request-key.rst            |  2 +-
 Documentation/sound/cards/joystick.rst                 |  2 +-
 Documentation/sound/hd-audio/notes.rst                 |  2 +-
 .../sound/kernel-api/writing-an-alsa-driver.rst        |  2 +-
 Documentation/usb/gadget-testing.txt                   |  2 +-
 31 files changed, 59 insertions(+), 55 deletions(-)

-- 
2.14.2

             reply	other threads:[~2017-10-10 17:37 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-10 17:35 Tom Saeger [this message]
2017-10-10 17:36 ` [PATCH 1/8] Documentation: fix driver-api doc refs Tom Saeger
2017-10-10 21:39   ` Rafael J. Wysocki
2017-10-10 17:36 ` [PATCH 2/8] Documentation: fix admin-guide " Tom Saeger
2017-10-10 21:40   ` Rafael J. Wysocki
2017-10-10 17:36 ` [PATCH 3/8] Documentation: fix input related " Tom Saeger
2017-10-10 18:08   ` Takashi Iwai
2017-10-10 17:36 ` [PATCH 4/8] Documentation: fix security " Tom Saeger
2017-10-10 17:36 ` [PATCH 5/8] Documentation: fix media " Tom Saeger
2017-10-10 17:36 ` [PATCH 6/8] Documentation: fix sound " Tom Saeger
2017-10-10 18:09   ` Takashi Iwai
2017-10-10 17:36 ` [PATCH 7/8] Documentation: fix usb " Tom Saeger
2017-10-10 17:37 ` [PATCH 8/8] Documentation: fix networking " Tom Saeger
2017-10-12 17:24 ` [PATCH 0/8] Documentation: fix invalid Documentation refs (1) Jonathan Corbet
2017-10-12 19:01   ` Tom Saeger

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.1507653969.git.tom.saeger@oracle.com \
    --to=tom.saeger@oracle.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox