summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2022-05-13 10:53:40 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2022-05-23 16:26:30 +0200
commit5c4cf1f708c5879d1c79092a3ab0734fa5c7cfdb (patch)
tree4341578bea8dffae200064383e48ca0de2a3ffa5
parentCONTRIBUTING.rst: Use LibBSD (diff)
downloadrtems-libbsd-5c4cf1f708c5879d1c79092a3ab0734fa5c7cfdb.tar.bz2
libbsd.txt: Move introduction content
-rw-r--r--CONTRIBUTING.rst22
-rw-r--r--libbsd.txt29
2 files changed, 22 insertions, 29 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 0ea66946..1bcdca31 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -9,6 +9,28 @@ goal of the LibBSD is to stay in synchronization with FreeBSD. This is only
feasible if certain rules are in place. Otherwise, managing more than a
thousand imported source files will become too labour intensive eventually.
+The LibBSD makes FreeBSD subsystems like TCP/IP, USB, SD/MMC, PCIe, and some
+more usable for RTEMS. It tries to follow the FreeBSD development as close as
+possible and therefore is updated to the latest FreeBSD HEAD revision of the
+associated FreeBSD branch from time to time. To find out which version of
+FreeBSD is currently used as the base version for LibBSD please take a look at
+the ``freebsd-org`` submodule.
+
+This guide captures information on the process of merging code from FreeBSD,
+RTEMS specific support files, general guidelines on what modifications to the
+FreeBSD source are permitted, and some other topics. For building the library,
+see the `README <README.rst>`_.
+
+Goals of the LibBSD activity are
+
+* provide functionality from FreeBSD to RTEMS,
+* ease updating to future FreeBSD versions,
+* ease tracking changes in FreeBSD code,
+* minimize manual changes in FreeBSD code.
+
+We will work to push our changes upstream to the FreeBSD Project and minimize
+changes required at each update point.
+
What is in the Git Repository
=============================
diff --git a/libbsd.txt b/libbsd.txt
index 3d665500..2cb7fb07 100644
--- a/libbsd.txt
+++ b/libbsd.txt
@@ -5,35 +5,6 @@ RTEMS BSD Library Guide
:numbered:
:website: http://www.rtems.org/
-The libbsd makes FreeBSD subsystems like TCP/IP, USB, SD and some more usable
-for RTEMS. It tries to follow the FreeBSD development as close as possible and
-therefore is updated to the latest FreeBSD HEAD revision from time to time.
-To find out which version of FreeBSD is currently used as the base version for
-libbsd please take a look at the
-https://git.rtems.org/rtems-libbsd/log/freebsd-org[freebsd-org] submodule.
-
-This is a guide which captures information on the
-process of merging code from FreeBSD, building this library,
-RTEMS specific support files, and general guidelines on what
-modifications to the FreeBSD source are permitted.
-
-Goals of this effort are
-
-* update TCP/IP and provide USB in RTEMS,
-* ease updating to future FreeBSD versions,
-* ease tracking changes in FreeBSD code,
-* minimize manual changes in FreeBSD code, and
-* define stable kernel/device driver API which is implemented
-by both RTEMS and FreeBSD. This is the foundation of the port.
-
-We will work to push our changes upstream to the FreeBSD Project
-and minimize changes required at each update point.
-
-*******************************************************************************
-This is a work in progress and is very likely to be incomplete.
-Please help by adding to it.
-*******************************************************************************
-
== Getting Started
=== Tool Chain ===