From: Florian Schmidt Date: Wed, 29 Nov 2017 10:53:03 +0000 (+0100) Subject: Initial public release: documentation X-Git-Tag: RELEASE-0.2^0 X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=1f4162253c2525d6723eecfca8f14667d35ccfe2;p=unikraft%2Flibs%2Fnewlib.git Initial public release: documentation This contains the initial documentation for newlib for Unikraft. Signed-off-by: Florian Schmidt --- diff --git a/CODING_STYLE.md b/CODING_STYLE.md new file mode 100644 index 0000000..5730041 --- /dev/null +++ b/CODING_STYLE.md @@ -0,0 +1,4 @@ +Coding Style +============ + +Please refer to the `CODING_STYLE.md` file in the main Unikraft repository. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5f55eca --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,4 @@ +Contributing to Unikraft +======================= + +Please refer to the `CONTRIBUTING.md` file in the main Unikraft repository. diff --git a/COPYING.md b/COPYING.md new file mode 100644 index 0000000..bf8ba1e --- /dev/null +++ b/COPYING.md @@ -0,0 +1,46 @@ +License +======= + +Unikraft newlib wrappers +------------------------ + +This repository contains wrapper code to build newlib with Unikraft. The code +is published as a mixture of BSD and MIT licences; each C code file in +this repository should declare who is the copyright owner and under which terms +and conditions the code is licensed. If such a licence note is missing, the +following copyright notice will apply: + + Copyright (c) 2017, NEC Europe Ltd., NEC Corporation. All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + 3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + POSSIBILITY OF SUCH DAMAGE. + +newlib source code +------------------ + +During building, the build system will download the newlib source code and +build source code from the `newlib/libc` and `newlib/libm` directories. The +code in this directories has a variety of licences, the details of which are +explained in the `README.newlib` file in the root directory of the newlib code. diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 0000000..5d44b60 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,11 @@ +Maintainers List +================ + +For notes on how to read this information, please refer to `MAINTAINERS.md` in +the main Unikraft repository. + + NEWLIB-UNIKRAFT + M: Felipe Huici + M: Florian Schmidt + L: minios-devel@lists.xen.org + F: * diff --git a/README.md b/README.md new file mode 100644 index 0000000..1c25c99 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +newlib for Unikraft +=================== + +Please refer to the `README.md` as well as the documentation in the `doc/` +subdirectory of the main unikraft repository.