From 4731d5a4ac84accb8f4c3e224816d81055041e2b Mon Sep 17 00:00:00 2001 From: Andrey Konovalov Date: Wed, 14 Jun 2017 13:58:35 +0200 Subject: docs: minor clean up --- README.md | 8 ++++---- docs/linux_kernel_reporting_bugs.md | 15 +++++++++++++++ docs/reporting_linux_kernel_bugs.md | 15 --------------- 3 files changed, 19 insertions(+), 19 deletions(-) create mode 100644 docs/linux_kernel_reporting_bugs.md delete mode 100644 docs/reporting_linux_kernel_bugs.md diff --git a/README.md b/README.md index 9b4b9430a..8214ba537 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ You can subscribe to it with a google account or by sending an email to syzkalle List of [found bugs](docs/found_bugs.md). -How to [report Linux kernel bugs](docs/reporting_linux_kernel_bugs.md). +How to [report Linux kernel bugs](docs/linux_kernel_reporting_bugs.md). How to [contribute](docs/contributing.md). @@ -26,7 +26,7 @@ The following components are needed to use syzkaller: - syzkaller itself Generic steps to set up syzkaller are described below. -More specific information (like the exact steps for a particular host system, VM type and a kernel architecture) can be found on [the wiki](https://github.com/google/syzkaller/wiki). +More specific information (like the exact steps for a particular host system, VM type and a kernel architecture) can be found in [the documentation](docs/). ### C Compiler @@ -64,9 +64,9 @@ These are the generic requirements for a syzkaller VM: 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. -Detailed steps for setting up syzkaller with QEMU on a Linux host can be found on wiki for [x86-64](docs/setup_ubuntu-host_qemu-vm_x86-64-kernel.md) and [arm64](docs/setup_linux-host_qemu-vm_arm64-kernel.md) kernels. +Detailed steps for setting up syzkaller with QEMU on a Linux host are avaialble for [x86-64](docs/setup_ubuntu-host_qemu-vm_x86-64-kernel.md) and [arm64](docs/setup_linux-host_qemu-vm_arm64-kernel.md) kernels. -For some details on fuzzing the kernel on an Android device check out [this wiki page](docs/setup_linux-host_android-device_arm64-kernel.md) and the explicit instructions for an Odroid C2 board are available [here](docs/setup_ubuntu-host_odroid-c2-board_arm64-kernel.md). +For some details on fuzzing the kernel on an Android device check out [this page](docs/setup_linux-host_android-device_arm64-kernel.md) and the explicit instructions for an Odroid C2 board are available [here](docs/setup_ubuntu-host_odroid-c2-board_arm64-kernel.md). ### Syzkaller diff --git a/docs/linux_kernel_reporting_bugs.md b/docs/linux_kernel_reporting_bugs.md new file mode 100644 index 000000000..fde46057a --- /dev/null +++ b/docs/linux_kernel_reporting_bugs.md @@ -0,0 +1,15 @@ +## Reporting Linux kernel bugs + +Before reporting a bug make sure nobody else already reported it. The easiest way to do this is to search through the [syzkaller mailing list](https://groups.google.com/forum/#!forum/syzkaller) for key frames present in the kernel stack traces. + +Please report found bugs to the Linux kernel maintainers. +To find out the list of maintainers responsible for a particular kernel subsystem, use the [get_maintainer.pl](https://github.com/torvalds/linux/blob/master/scripts/get_maintainer.pl) script: `./scripts/get_maintainer.pl -f guilty_file.c`. +Please also add `syzkaller@googlegroups.com` to the CC list. + +If the bug is reproducible, include the reproducer (C source if possible, otherwise a syzkaller program) and `.config` you used for your kernel. +Bugs without reproducers are way less likely to be triaged and fixed. +Make sure to also mention the exact kernel branch and revision. + +Many kernel mailing lists reject HTML formatted messages, so use the plain text mode when sending the report. + +If you believe that a found bug poses potential security threat, consider reporting it directly to `security@kernel.org`. diff --git a/docs/reporting_linux_kernel_bugs.md b/docs/reporting_linux_kernel_bugs.md deleted file mode 100644 index fde46057a..000000000 --- a/docs/reporting_linux_kernel_bugs.md +++ /dev/null @@ -1,15 +0,0 @@ -## Reporting Linux kernel bugs - -Before reporting a bug make sure nobody else already reported it. The easiest way to do this is to search through the [syzkaller mailing list](https://groups.google.com/forum/#!forum/syzkaller) for key frames present in the kernel stack traces. - -Please report found bugs to the Linux kernel maintainers. -To find out the list of maintainers responsible for a particular kernel subsystem, use the [get_maintainer.pl](https://github.com/torvalds/linux/blob/master/scripts/get_maintainer.pl) script: `./scripts/get_maintainer.pl -f guilty_file.c`. -Please also add `syzkaller@googlegroups.com` to the CC list. - -If the bug is reproducible, include the reproducer (C source if possible, otherwise a syzkaller program) and `.config` you used for your kernel. -Bugs without reproducers are way less likely to be triaged and fixed. -Make sure to also mention the exact kernel branch and revision. - -Many kernel mailing lists reject HTML formatted messages, so use the plain text mode when sending the report. - -If you believe that a found bug poses potential security threat, consider reporting it directly to `security@kernel.org`. -- cgit mrf-deployment