From 3b8291bd1a368667df02bcf7cbf09b8a6a0e7dbb Mon Sep 17 00:00:00 2001
From: Dmitry Vyukov <dvyukov@google.com>
Date: Tue, 26 Feb 2019 13:38:57 +0100
Subject: [PATCH] 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.
---
 README.md                              | 6 +++---
 docs/{freebsd.md => freebsd/README.md} | 0
 docs/freebsd/found_bugs.md             | 7 +++++++
 docs/{fuchsia.md => fuchsia/README.md} | 0
 docs/{gvisor.md => gvisor/README.md}   | 0
 docs/setup.md                          | 8 +++++++-
 6 files changed, 17 insertions(+), 4 deletions(-)
 rename docs/{freebsd.md => freebsd/README.md} (100%)
 create mode 100644 docs/freebsd/found_bugs.md
 rename docs/{fuchsia.md => fuchsia/README.md} (100%)
 rename docs/{gvisor.md => gvisor/README.md} (100%)

diff --git a/README.md b/README.md
index 6ce14b20..f94d39ca 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
similarity index 100%
rename from docs/freebsd.md
rename to docs/freebsd/README.md
diff --git a/docs/freebsd/found_bugs.md b/docs/freebsd/found_bugs.md
new file mode 100644
index 00000000..5de46cce
--- /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
similarity index 100%
rename from docs/fuchsia.md
rename to docs/fuchsia/README.md
diff --git a/docs/gvisor.md b/docs/gvisor/README.md
similarity index 100%
rename from docs/gvisor.md
rename to docs/gvisor/README.md
diff --git a/docs/setup.md b/docs/setup.md
index 98184c22..81b001c9 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`: