Source: util-linux
Version: 2.35.1-5
Severity: minor
Tags: patch

Dear Maintainer,

I noticed that fdisk(8) references a file that is no longer there,
so I went through all references to the kernel Documentation/ tree in
util-linux and fixed them for the latest git release (v5.7-rc5).

The one ref I wasn't 100% sure about is fdisk(8)'s
Documentation/admin-guide/devices.txt, which has a ReST version as well,
though it seems less useful.

The patch applies cleanly on top of 2.35.1-5 and current upstream HEAD
(366e163961add54f4822541f3d660b4e0578b207);
I cannot signoff on the patch for personal reasons,
but I'm licensing it as public domain and can certify (a), so,
if my reading of the DCO is right, you could certify either (b) or (c),
should you wish to bring the patch upstream;
thank you for understanding.

Best,
наб

-- System Information:
Debian Release: 10.4
  APT prefers stable-updates
  APT policy: (500, 'stable-updates'), (500, 'stable')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 4.19.0-8-amd64 (SMP w/24 CPU cores)
Kernel taint flags: TAINT_PROPRIETARY_MODULE, TAINT_FIRMWARE_WORKAROUND, 
TAINT_OOT_MODULE, TAINT_UNSIGNED_MODULE
Locale: LANG=en_GB.UTF-8, LC_CTYPE=en_GB.UTF-8 (charmap=UTF-8), 
LANGUAGE=en_GB:en (charmap=UTF-8)
Shell: /bin/sh linked to /usr/bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled

-- no debconf information
From f40fcda769cf7e19f222041800f62dd0e81310d5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=BD=D0=B0=D0=B1?= <[email protected]>
Date: Sun, 17 May 2020 13:36:41 +0200
Subject: [PATCH] Fix dead references to kernel documentation

Based on v5.7-rc5, most date back to reorganisation of the
Documentation/ tree in 2016:

fdisk.8:   Documentation/{,admin-guide/}devices.txt
eject.c:   Documentation/{,userspace-api/}ioctl/cdrom.rst
mount.8:   Documentation/filesystems/adfs.{txt,rst}
rfkill.8:  Documentation/{rfkill.txt,driver-api/rfkill.rst}
tunelp.8:  Documentation/{parport.txt,admin-guide/parport.rst}
zramctl.8: Documentation/{blockdev/zram.txt,admin-guide/blockdev/zram.rst}
---
 disk-utils/fdisk.8  | 2 +-
 sys-utils/eject.c   | 2 +-
 sys-utils/mount.8   | 2 +-
 sys-utils/rfkill.8  | 2 +-
 sys-utils/tunelp.8  | 2 +-
 sys-utils/zramctl.8 | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/disk-utils/fdisk.8 b/disk-utils/fdisk.8
index cc172a0a5..dcc587fed 100644
--- a/disk-utils/fdisk.8
+++ b/disk-utils/fdisk.8
@@ -161,7 +161,7 @@ The
 .I partition
 is a device name followed by a partition number.  For example, /dev/sda1 is the
 first partition on the first hard disk in the system.  See also Linux kernel
-documentation (the Documentation/devices.txt file).
+documentation (the Documentation/admin-guide/devices.txt file).
 
 .SH SIZES
 The "last sector" dialog accepts partition size specified by number of sectors
diff --git a/sys-utils/eject.c b/sys-utils/eject.c
index 2f3b200bf..651ecc7d8 100644
--- a/sys-utils/eject.c
+++ b/sys-utils/eject.c
@@ -330,7 +330,7 @@ static void auto_eject(const struct eject_control *ctl)
  * Stops CDROM from opening on manual eject button press.
  * This can be useful when you carry your laptop
  * in your bag while it's on and no CD inserted in it's drive.
- * Implemented as found in Documentation/ioctl/cdrom.txt
+ * Implemented as found in Documentation/userspace-api/ioctl/cdrom.rst
  */
 static void manual_eject(const struct eject_control *ctl)
 {
diff --git a/sys-utils/mount.8 b/sys-utils/mount.8
index 13a5f7167..7f5da2d2b 100644
--- a/sys-utils/mount.8
+++ b/sys-utils/mount.8
@@ -1342,7 +1342,7 @@ Set the owner and group of the files in the filesystem (default: uid=gid=0).
 Set the permission mask for ADFS 'owner' permissions and 'other' permissions,
 respectively (default: 0700 and 0077, respectively).
 See also
-.IR /usr/src/linux/Documentation/filesystems/adfs.txt .
+.IR /usr/src/linux/Documentation/filesystems/adfs.rst .
 
 .SS "Mount options for affs"
 .TP
diff --git a/sys-utils/rfkill.8 b/sys-utils/rfkill.8
index 9eff913b8..eb640954f 100644
--- a/sys-utils/rfkill.8
+++ b/sys-utils/rfkill.8
@@ -110,7 +110,7 @@ for the Debian project (and may be used by others).
 .SH "SEE ALSO"
 .BR powertop (8),
 .BR systemd-rfkill (8),
-.UR https://\:git.\:kernel.\:org/\:pub/\:scm/\:linux/\:kernel/\:git/\:torvalds/\:linux.git/\:tree/\:Documentation/\:rfkill.txt
+.UR https://\:git.\:kernel.\:org/\:pub/\:scm/\:linux/\:kernel/\:git/\:torvalds/\:linux.git/\:tree/\:Documentation/\:driver-api/\:rfkill.rst
 Linux kernel documentation
 .UE
 .SH AVAILABILITY
diff --git a/sys-utils/tunelp.8 b/sys-utils/tunelp.8
index 5c927458f..7716ba7e1 100644
--- a/sys-utils/tunelp.8
+++ b/sys-utils/tunelp.8
@@ -34,7 +34,7 @@ irq is handled by the parport driver.  You can change the parport irq for
 example via
 .IR /proc/parport/*/irq .
 Read
-.I /usr/src/linux/Documentation/parport.txt
+.I /usr/src/linux/Documentation/admin-guide/parport.rst
 for more details on parport.
 .TP
 \fB\-t\fR, \fB\-\-time\fR \fImilliseconds\fR
diff --git a/sys-utils/zramctl.8 b/sys-utils/zramctl.8
index c6ecdc3d5..12983f144 100644
--- a/sys-utils/zramctl.8
+++ b/sys-utils/zramctl.8
@@ -118,7 +118,7 @@ and use it as swap device.
 # zramctl --reset /dev/zram0
 .fi
 .SH SEE ALSO
-.UR http://git.\:kernel.\:org\:/cgit\:/linux\:/kernel\:/git\:/torvalds\:/linux.git\:/tree\:/Documentation\:/blockdev\:/zram.txt
+.UR http://git.\:kernel.\:org\:/cgit\:/linux\:/kernel\:/git\:/torvalds\:/linux.git\:/tree\:/Documentation\:/admin-guide\:/blockdev\:/zram.rst
 Linux kernel documentation
 .UE .
 .SH AUTHORS
-- 
2.20.1

Attachment: signature.asc
Description: PGP signature

Reply via email to