Documentation: fix invalid Documentation refs (2)
Subsystems (10)
cover Documentation: fix invalid Documentation refs (2)
Batch (2) set of simple document ref fixes.
Tom Saeger (8):
Documentation: fix locking rt-mutex doc refs
Documentation: fix ref to sphinx/kerneldoc.py
Documentation: fix ref to workqueue content
Documentation: fix ref to coccinelle content
Documentation: fix ref to trace stm content
Documentation: fix ref to power basic-pm-debugging
Documentation: fix selftests related file refs
Documentation: fix ref to gpio.txt
Documentation/ABI/obsolete/sysfs-gpio | 2 +- .../RCU/Design/Expedited-Grace-Periods/Expedited-Grace-Periods.html | 2 +- Documentation/doc-guide/kernel-doc.rst | 2 +- Documentation/filesystems/dnotify.txt | 2 +- Documentation/locking/rt-mutex-design.txt | 2 +- Documentation/pi-futex.txt | 2 +- Documentation/power/interface.txt | 2 +- Documentation/process/4.Coding.rst | 2 +- Documentation/trace/intel_th.txt | 2 +- Documentation/watchdog/hpwdt.txt | 2 +- Documentation/watchdog/pcwd-watchdog.txt | 2 +- 11 files changed, 11 insertions(+), 11 deletions(-)
Signature · 1 line
2.14.2
PATCH 1/8 Documentation: fix locking rt-mutex doc refs
Signed-off-by Tom Saeger <[email protected]>
--- Documentation/locking/rt-mutex-design.txt | 2 +- Documentation/pi-futex.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/locking/rt-mutex-design.txt +1 -1
@@ -8,7 +8,7 @@ RT-mutex implementation design This document tries to describe the design of the rtmutex.c implementation. It doesn't describe the reasons why rtmutex.c exists. For that please see -Documentation/rt-mutex.txt. Although this document does explain problems +Documentation/locking/rt-mutex.txt. Although this document does explain problems that happen without this code, but that is in the concept to understand what the code actually is doing.
Documentation/pi-futex.txt +1 -1
@@ -119,4 +119,4 @@ properties of futexes, and all four combinations are possible: futex, robust-futex, PI-futex, robust+PI-futex. More details about priority inheritance can be found in -Documentation/rt-mutex.txt. +Documentation/locking/rt-mutex.txt.
Signature · 1 line
2.14.2
PATCH 2/8 Documentation: fix ref to sphinx/kerneldoc.py
In reply to Tom SaegerSigned-off-by Tom Saeger <[email protected]>
--- Documentation/doc-guide/kernel-doc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/doc-guide/kernel-doc.rst +1 -1
@@ -65,7 +65,7 @@ Without options, the kernel-doc directive includes all documentation comments from the source file. The kernel-doc extension is included in the kernel source tree, at -``Documentation/sphinx/kernel-doc.py``. Internally, it uses the +``Documentation/sphinx/kerneldoc.py``. Internally, it uses the ``scripts/kernel-doc`` script to extract the documentation comments from the source.
Signature · 1 line
2.14.2
PATCH 3/8 Documentation: fix ref to workqueue content
In reply to Tom SaegerSigned-off-by Tom Saeger <[email protected]>
--- .../RCU/Design/Expedited-Grace-Periods/Expedited-Grace-Periods.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/RCU/Design/Expedited-Grace-Periods/Expedited-Grace-Periods.html +1 -1
@@ -527,7 +527,7 @@ grace period also drove it to completion. This straightforward approach had the disadvantage of needing to account for POSIX signals sent to user tasks, so more recent implemementations use the Linux kernel's -<a href="https://www.kernel.org/doc/Documentation/workqueue.txt">workqueues</a>. +<a href="https://www.kernel.org/doc/Documentation/core-api/workqueue.rst">workqueues</a>. <p> The requesting task still does counter snapshotting and funnel-lock
Signature · 1 line
2.14.2
Re: [PATCH 3/8] Documentation: fix ref to workqueue content
Quoted 3 lines · Tom Saeger
Signed-off-by Tom Saeger <[email protected]>--- .../RCU/Design/Expedited-Grace-Periods/Expedited-Grace-Periods.html | 2 +-
Someone(tm) should convert the last three html files to rst one of these days!
In the mean time, I guess this is good enough.
BR,
Jani.
Quoted 15 lines
1 file changed, 1 insertion(+), 1 deletion(-)Documentation/RCU/Design/Expedited-Grace-Periods/Expedited-Grace-Periods.html +1
-1@@ -527,7 +527,7 @@ grace period also drove it to completion. This straightforward approach had the disadvantage of needing to account for POSIX signals sent to user tasks, so more recent implemementations use the Linux kernel's -<a href="https://www.kernel.org/doc/Documentation/workqueue.txt">workqueues</a>. +<a href="https://www.kernel.org/doc/Documentation/core-api/workqueue.rst">workqueues</a>. <p> The requesting task still does counter snapshotting and funnel-lock
Signature · 1 line
Jani Nikula, Intel Open Source Technology Center
PATCH 4/8 Documentation: fix ref to coccinelle content
In reply to Tom SaegerSigned-off-by Tom Saeger <[email protected]>
--- Documentation/process/4.Coding.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/process/4.Coding.rst +1 -1
@@ -307,7 +307,7 @@ variety of potential coding problems; it can also propose fixes for those problems. Quite a few "semantic patches" for the kernel have been packaged under the scripts/coccinelle directory; running "make coccicheck" will run through those semantic patches and report on any problems found. See -Documentation/coccinelle.txt for more information. +Documentation/dev-tools/coccinelle.rst for more information. Other kinds of portability errors are best found by compiling your code for other architectures. If you do not happen to have an S/390 system or a
Signature · 1 line
2.14.2
PATCH 5/8 Documentation: fix ref to trace stm content
In reply to Tom SaegerSigned-off-by Tom Saeger <[email protected]>
--- Documentation/trace/intel_th.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/trace/intel_th.txt +1 -1
@@ -37,7 +37,7 @@ description is at Documentation/ABI/testing/sysfs-bus-intel_th-devices-gth. STH registers an stm class device, through which it provides interface to userspace and kernelspace software trace sources. See -Documentation/tracing/stm.txt for more information on that. +Documentation/trace/stm.txt for more information on that. MSU can be configured to collect trace data into a system memory buffer, which can later on be read from its device nodes via read() or
Signature · 1 line
2.14.2
PATCH 6/8 Documentation: fix ref to power basic-pm-debugging
In reply to Tom SaegerSigned-off-by Tom Saeger <[email protected]>
--- Documentation/power/interface.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/power/interface.txt +1 -1
@@ -43,7 +43,7 @@ The currently selected option is printed in square brackets. The 'platform' option is only available if the platform provides a special mechanism to put the system to sleep after creating a hibernation image (ACPI does that, for example). The 'suspend' option is available if Suspend-to-RAM -is supported. Refer to Documentation/power/basic_pm_debugging.txt for the +is supported. Refer to Documentation/power/basic-pm-debugging.txt for the description of the 'test_resume' option. To select an option, write the string representing it to /sys/power/disk.
Signature · 1 line
2.14.2
Re: [PATCH 6/8] Documentation: fix ref to power basic-pm-debugging
Quoted 10 lines · Tom Saeger
Signed-off-by Tom Saeger <[email protected]>--- Documentation/power/interface.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)Documentation/power/interface.txt +0
-0
Documentation/power/interface.txt The currently selected option is printed in square brackets.
Quoted 9 lines
Documentation/power/interface.txt +1
-2@@ -43,7 +43,7 @@ The currently selected option is printed in square brackets. The 'platform' option is only available if the platform provides a special mechanism to put the system to sleep after creating a hibernation image (ACPI does that, for example). The 'suspend' option is available if Suspend-to-RAM -is supported. Refer to Documentation/power/basic_pm_debugging.txt for the +is supported. Refer to Documentation/power/basic-pm-debugging.txt for the description of the 'test_resume' option. To select an option, write the string representing it to /sys/power/disk. --
PATCH 7/8 Documentation: fix selftests related file refs
In reply to Tom SaegerMake refs to selftests files valid including:
- watchdog-test.c
- dnotify_test.c
Signed-off-by Tom Saeger <[email protected]>
--- Documentation/filesystems/dnotify.txt | 2 +- Documentation/watchdog/hpwdt.txt | 2 +- Documentation/watchdog/pcwd-watchdog.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-)
Documentation/filesystems/dnotify.txt +1 -1
@@ -62,7 +62,7 @@ disabled, fcntl(fd, F_NOTIFY, ...) will return -EINVAL. Example ------- -See Documentation/filesystems/dnotify_test.c for an example. +See tools/testing/selftests/filesystems/dnotify_test.c for an example. NOTE ----
Documentation/watchdog/hpwdt.txt +1 -1
@@ -15,7 +15,7 @@ Last reviewed: 05/20/2016 Watchdog functionality is enabled like any other common watchdog driver. That is, an application needs to be started that kicks off the watchdog timer. A - basic application exists in the Documentation/watchdog/src directory called + basic application exists in tools/testing/selftests/watchdog/ named watchdog-test.c. Simply compile the C file and kick it off. If the system gets into a bad state and hangs, the HPE ProLiant iLO timer register will not be updated in a timely fashion and a hardware system reset (also known as
Documentation/watchdog/pcwd-watchdog.txt +1 -1
@@ -25,7 +25,7 @@ Last reviewed: 10/05/2007 If you want to write a program to be compatible with the PC Watchdog driver, simply use of modify the watchdog test program: - Documentation/watchdog/src/watchdog-test.c + tools/testing/selftests/watchdog/watchdog-test.c Other IOCTL functions include:
Signature · 1 line
2.14.2
Re: [PATCH 7/8] Documentation: fix selftests related file refs
Quoted 29 lines · Tom Saeger
Make refs to selftests files valid including:
-watchdog-test.c
-dnotify_test.cSigned-off-by Tom Saeger <[email protected]>--- Documentation/filesystems/dnotify.txt | 2 +- Documentation/watchdog/hpwdt.txt | 2 +- Documentation/watchdog/pcwd-watchdog.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-)Documentation/filesystems/dnotify.txt +1
-1@@ -62,7 +62,7 @@ disabled, fcntl(fd, F_NOTIFY, ...) will return -EINVAL. Example ------- -See Documentation/filesystems/dnotify_test.c for an example. +See tools/testing/selftests/filesystems/dnotify_test.c for an example. NOTE ----Documentation/watchdog/hpwdt.txt +0
-0
Documentation/watchdog/hpwdt.txt Last reviewed: 05/20/2016 · line 21
Quoted 8 lines
Documentation/watchdog/hpwdt.txt +1
-1@@ -15,7 +15,7 @@ Last reviewed: 05/20/2016 Watchdog functionality is enabled like any other common watchdog driver. That is, an application needs to be started that kicks off the watchdog timer. A - basic application exists in the Documentation/watchdog/src directory called + basic application exists in tools/testing/selftests/watchdog/ named watchdog-test.c. Simply compile the C file and kick it off. If the system gets into a bad state and hangs, the HPE ProLiant iLO timer register will not be updated in a timely fashion and a hardware system reset (also known as
Taking over hpwdt for Jimmy Vance.
Signed-off-by Jerry Hoemann <[email protected]>
Quoted 20 lines
Documentation/watchdog/pcwd-watchdog.txt +1
-1@@ -25,7 +25,7 @@ Last reviewed: 10/05/2007 If you want to write a program to be compatible with the PC Watchdog driver, simply use of modify the watchdog test program: - Documentation/watchdog/src/watchdog-test.c + tools/testing/selftests/watchdog/watchdog-test.c Other IOCTL functions include:Signature · 6 lines
2.14.2 -- To unsubscribe from this list: send the line "unsubscribe linux-watchdog" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
Signature · 3 lines
----------------------------------------------------------------------------- Jerry Hoemann Software Engineer Hewlett Packard Enterprise -----------------------------------------------------------------------------
Re: [7/8] Documentation: fix selftests related file refs
In reply to Tom SaegerQuoted 6 lines · Tom Saeger
Make refs to selftests files valid including:
-watchdog-test.c
-dnotify_test.cSigned-off-by Tom Saeger <[email protected]>Signed-off-by Jerry Hoemann <[email protected]>
That should have been a Reviewed-by: for the hpwdt code.
Otherwise
Reviewed-by Guenter Roeck <[email protected]>
Quoted 45 lines
--- Documentation/filesystems/dnotify.txt | 2 +- Documentation/watchdog/hpwdt.txt | 2 +- Documentation/watchdog/pcwd-watchdog.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-)Documentation/filesystems/dnotify.txt +1
-1@@ -62,7 +62,7 @@ disabled, fcntl(fd, F_NOTIFY, ...) will return -EINVAL. Example ------- -See Documentation/filesystems/dnotify_test.c for an example. +See tools/testing/selftests/filesystems/dnotify_test.c for an example. NOTE ----Documentation/watchdog/hpwdt.txt +1
-1@@ -15,7 +15,7 @@ Last reviewed: 05/20/2016 Watchdog functionality is enabled like any other common watchdog driver. That is, an application needs to be started that kicks off the watchdog timer. A - basic application exists in the Documentation/watchdog/src directory called + basic application exists in tools/testing/selftests/watchdog/ named watchdog-test.c. Simply compile the C file and kick it off. If the system gets into a bad state and hangs, the HPE ProLiant iLO timer register will not be updated in a timely fashion and a hardware system reset (also known asDocumentation/watchdog/pcwd-watchdog.txt +1
-1@@ -25,7 +25,7 @@ Last reviewed: 10/05/2007 If you want to write a program to be compatible with the PC Watchdog driver, simply use of modify the watchdog test program: - Documentation/watchdog/src/watchdog-test.c + tools/testing/selftests/watchdog/watchdog-test.c Other IOCTL functions include:
PATCH 8/8 Documentation: fix ref to gpio.txt
In reply to Tom SaegerSigned-off-by Tom Saeger <[email protected]>
--- Documentation/ABI/obsolete/sysfs-gpio | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/ABI/obsolete/sysfs-gpio +1 -1
@@ -11,7 +11,7 @@ Description: Kernel code may export it for complete or partial access. GPIOs are identified as they are inside the kernel, using integers in - the range 0..INT_MAX. See Documentation/gpio.txt for more information. + the range 0..INT_MAX. See Documentation/gpio/gpio.txt for more information. /sys/class/gpio /export ... asks the kernel to export a GPIO to userspace
Signature · 1 line
2.14.2
Re: [PATCH 8/8] Documentation: fix ref to gpio.txt
Quoted 1 line · Tom Saeger
Signed-off-by Tom Saeger <[email protected]>
Patch applied.
Yours,
Linus Walleij
Jonathan Corbet
maintainerQuoted 12 lines · On Thu, 12 Oct 2017 15:23:26 -0500 Tom Saeger <[email protected]> wrote:
Batch (2) set of simple document ref fixes.
Tom Saeger (8):
Documentation: fix locking rt-mutex doc refs
Documentation: fix ref tosphinx/kerneldoc.py
Documentation: fix ref to workqueue content
Documentation: fix ref to coccinelle content
Documentation: fix ref to trace stm content
Documentation: fix ref to power basic-pm-debugging
Documentation: fix selftests related file refs
Documentation: fix ref to gpio.txt
I've applied the set (except 8/8, which Linus W. already grabbed).
Thanks,
jon