aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAndrey Konovalov <andreyknvl@google.com>2017-10-26 18:48:54 +0200
committerAndrey Konovalov <andreyknvl@gmail.com>2017-10-27 10:04:34 +0200
commit26d265c811929d03c4d27e5fe53f7de5bde32215 (patch)
treeb74bc3965e7f36489b2cea0b66fd74efb555c483 /docs
parent0a4d6e56b9194cd5c1022b6737367ff5bc368350 (diff)
docs, tools: add local link checker
This commit adds tools/check_links.py script, that checks that all local links from documentation files are valid; fixes some of the invalid links that we had; and makes travis buildbot check them as well.
Diffstat (limited to 'docs')
-rw-r--r--docs/found_bugs_usb.md2
-rw-r--r--docs/internals.md2
-rw-r--r--docs/setup_generic.md2
-rw-r--r--docs/setup_ubuntu-host_qemu-vm_x86-64-kernel.md2
4 files changed, 4 insertions, 4 deletions
diff --git a/docs/found_bugs_usb.md b/docs/found_bugs_usb.md
index 3f375a6f9..c06ea4686 100644
--- a/docs/found_bugs_usb.md
+++ b/docs/found_bugs_usb.md
@@ -45,7 +45,7 @@
* [usb/net/hso: warning in hso_free_net_device](https://groups.google.com/forum/#!topic/syzkaller/J4Ua_T43Tjw)
* [usb/net/hso: global-out-of-bounds in hso_probe](https://groups.google.com/forum/#!topic/syzkaller/TDPcSXI2nBA)
* [usb/media/smsusb: use-after-free in worker_thread](https://groups.google.com/forum/#!topic/syzkaller/RS7QUTKo23s)
-* [usb/storage/uas: slab-out-of-bounds in uas_probe](https://groups.google.com/forum/#!topic/syzkaller/pCswO77gRlM) [[fix](786de92b3cb26012d3d0f00ee37adf14527f35c4)]
+* [usb/storage/uas: slab-out-of-bounds in uas_probe](https://groups.google.com/forum/#!topic/syzkaller/pCswO77gRlM) [[fix](https://github.com/torvalds/linux/commit/786de92b3cb26012d3d0f00ee37adf14527f35c4)]
* [usb/sound/usx2y: warning in usb_stream_new/__alloc_pages_slowpath](https://groups.google.com/forum/#!topic/syzkaller/vGwGJW_H-0I) [[fix](https://github.com/torvalds/linux/commit/7682e399485fe19622b6fd82510b1f4551e48a25)]
* [usb/media/pvrusb2: warning in pvr2_send_request_ex/usb_submit_urb](https://groups.google.com/forum/#!topic/syzkaller/M2GeMYS0f6E)
* [usb/media/smsusb: null-ptr-deref in smsusb_init_device](https://groups.google.com/forum/#!topic/syzkaller/yvhFawNoqxE)
diff --git a/docs/internals.md b/docs/internals.md
index b04770f9b..77efb7b31 100644
--- a/docs/internals.md
+++ b/docs/internals.md
@@ -45,7 +45,7 @@ and up to 100 `logN` and `reportN` files, one pair per test machine crash:
...
```
-Descriptions are extracted using a set of [regular expressions](/report/report.go#L33).
+Descriptions are extracted using a set of [regular expressions](/pkg/report/report.go#L33).
This set may need to be extended if you are using a different kernel architecture, or are just seeing a previously unseen kernel error messages.
`logN` files contain raw `syzkaller` logs and include kernel console output as well as programs executed before the crash.
diff --git a/docs/setup_generic.md b/docs/setup_generic.md
index 1655c8a63..0eba3f4da 100644
--- a/docs/setup_generic.md
+++ b/docs/setup_generic.md
@@ -48,7 +48,7 @@ These are the generic requirements for a syzkaller VM:
the debugfs filesystem at `/sys/kernel/debug`.
To use QEMU syzkaller VMs you have to install QEMU on your host system, see [QEMU docs](http://wiki.qemu.org/Manual) for details.
-The [create-image.sh](tools/create-image.sh) script can be used to create a suitable Linux image.
+The [create-image.sh](/tools/create-image.sh) script can be used to create a suitable Linux image.
Detailed steps for setting up syzkaller with QEMU on a Linux host are avaialble for [x86-64](setup_ubuntu-host_qemu-vm_x86-64-kernel.md) and [arm64](setup_linux-host_qemu-vm_arm64-kernel.md) kernels.
For some details on fuzzing the kernel on an Android device check out [this page](setup_linux-host_android-device_arm64-kernel.md) and the explicit instructions for an Odroid C2 board are available [here](setup_ubuntu-host_odroid-c2-board_arm64-kernel.md).
diff --git a/docs/setup_ubuntu-host_qemu-vm_x86-64-kernel.md b/docs/setup_ubuntu-host_qemu-vm_x86-64-kernel.md
index 01785f641..dc5211e1b 100644
--- a/docs/setup_ubuntu-host_qemu-vm_x86-64-kernel.md
+++ b/docs/setup_ubuntu-host_qemu-vm_x86-64-kernel.md
@@ -78,7 +78,7 @@ CONFIG_KASAN=y
CONFIG_KASAN_INLINE=y
```
-You might also want to enable some other kernel configs as described [here](linux-kernel-configs.md).
+You might also want to enable some other kernel configs as described [here](linux_kernel_configs.md).
Since enabling these options results in more sub options being available, we need to regenerate config. Run this and press enter each time when prompted for some config value to leave it as default:
``` bash