aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDmitry Vyukov <dvyukov@google.com>2019-02-26 13:38:57 +0100
committerDmitry Vyukov <dvyukov@google.com>2019-02-26 13:38:57 +0100
commit3b8291bd1a368667df02bcf7cbf09b8a6a0e7dbb (patch)
treeea807fcd78cc72a8ac0b3ce889c4394d6e9ed898
parent742e507fb1db5cdda57b74e01350efdfa408d7c2 (diff)
docs: move OS-specific docs to subdirs
Move freebsd, fuchsia, gvisor docs into own subdirs as we do for all other OSes. Add freebsd found_bugs.md.
-rw-r--r--README.md6
-rw-r--r--docs/freebsd/README.md (renamed from docs/freebsd.md)0
-rw-r--r--docs/freebsd/found_bugs.md7
-rw-r--r--docs/fuchsia/README.md (renamed from docs/fuchsia.md)0
-rw-r--r--docs/gvisor/README.md (renamed from docs/gvisor.md)0
-rw-r--r--docs/setup.md8
6 files changed, 17 insertions, 4 deletions
diff --git a/README.md b/README.md
index 6ce14b20a..f94d39ca5 100644
--- a/README.md
+++ b/README.md
@@ -21,12 +21,12 @@ Most of the documentation at this moment is related to the Linux kernel.
For other OS kernels check:
[Akaros](docs/akaros/README.md),
[Darwin/XNU](docs/darwin/README.md),
-[FreeBSD](docs/freebsd.md),
-[Fuchsia](docs/fuchsia.md),
+[FreeBSD](docs/freebsd/README.md),
+[Fuchsia](docs/fuchsia/README.md),
[NetBSD](docs/netbsd/README.md),
[OpenBSD](docs/openbsd/setup.md),
[Windows](docs/windows/README.md),
-[gVisor](docs/gvisor.md).
+[gVisor](docs/gvisor/README.md).
- [How to install syzkaller](docs/setup.md)
- [How to use syzkaller](docs/usage.md)
diff --git a/docs/freebsd.md b/docs/freebsd/README.md
index d15689ac5..d15689ac5 100644
--- a/docs/freebsd.md
+++ b/docs/freebsd/README.md
diff --git a/docs/freebsd/found_bugs.md b/docs/freebsd/found_bugs.md
new file mode 100644
index 000000000..5de46cce4
--- /dev/null
+++ b/docs/freebsd/found_bugs.md
@@ -0,0 +1,7 @@
+# Found Bugs
+
+Newer bugs come first
+
+- [Fix a locking bug in the IPPROTO_SCTP level SCTP_EVENT socket option.](https://reviews.freebsd.org/rS343954)
+- [Fix a locking issue in the IPPROTO_SCTP level SCTP_PEER_ADDR_THLDS socket](https://reviews.freebsd.org/rS343960)
+- [Check the index hasn't changed after writing the cmp entry.](https://reviews.freebsd.org/rS344517)
diff --git a/docs/fuchsia.md b/docs/fuchsia/README.md
index dd5243f91..dd5243f91 100644
--- a/docs/fuchsia.md
+++ b/docs/fuchsia/README.md
diff --git a/docs/gvisor.md b/docs/gvisor/README.md
index 63e353bda..63e353bda 100644
--- a/docs/gvisor.md
+++ b/docs/gvisor/README.md
diff --git a/docs/setup.md b/docs/setup.md
index 98184c221..81b001c97 100644
--- a/docs/setup.md
+++ b/docs/setup.md
@@ -1,7 +1,13 @@
# How to set up syzkaller
Generic setup instructions for fuzzing Linux kernel are outlined [here](linux/setup.md).
-For other OS kernels check: [Akaros](/docs/akaros/README.md), [FreeBSD](/docs/freebsd.md), [Fuchsia](/docs/fuchsia.md), [NetBSD](/docs/netbsd/README.md), [OpenBSD](/docs/openbsd/setup.md), [Windows](/docs/windows/README.md).
+For other OS kernels check:
+[Akaros](/docs/akaros/README.md),
+[FreeBSD](/docs/freebsd/README.md),
+[Fuchsia](/docs/fuchsia/README.md),
+[NetBSD](/docs/netbsd/README.md),
+[OpenBSD](/docs/openbsd/setup.md),
+[Windows](/docs/windows/README.md).
After following these instructions you should be able to run `syz-manager`, see it executing programs and be able to access statistics exposed at `http://127.0.0.1:56741`: