Skip to content

Commit 1f41622

Browse files
author
Florian Schmidt
committed
Initial public release: documentation
This contains the initial documentation for newlib for Unikraft. Signed-off-by: Florian Schmidt <[email protected]>
1 parent db39aae commit 1f41622

File tree

5 files changed

+70
-0
lines changed

5 files changed

+70
-0
lines changed

CODING_STYLE.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Coding Style
2+
============
3+
4+
Please refer to the `CODING_STYLE.md` file in the main Unikraft repository.

CONTRIBUTING.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Contributing to Unikraft
2+
=======================
3+
4+
Please refer to the `CONTRIBUTING.md` file in the main Unikraft repository.

COPYING.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
License
2+
=======
3+
4+
Unikraft newlib wrappers
5+
------------------------
6+
7+
This repository contains wrapper code to build newlib with Unikraft. The code
8+
is published as a mixture of BSD and MIT licences; each C code file in
9+
this repository should declare who is the copyright owner and under which terms
10+
and conditions the code is licensed. If such a licence note is missing, the
11+
following copyright notice will apply:
12+
13+
Copyright (c) 2017, NEC Europe Ltd., NEC Corporation. All rights reserved.
14+
15+
Redistribution and use in source and binary forms, with or without
16+
modification, are permitted provided that the following conditions
17+
are met:
18+
19+
1. Redistributions of source code must retain the above copyright
20+
notice, this list of conditions and the following disclaimer.
21+
2. Redistributions in binary form must reproduce the above copyright
22+
notice, this list of conditions and the following disclaimer in the
23+
documentation and/or other materials provided with the distribution.
24+
3. Neither the name of the copyright holder nor the names of its
25+
contributors may be used to endorse or promote products derived from
26+
this software without specific prior written permission.
27+
28+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
29+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31+
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
32+
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34+
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37+
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38+
POSSIBILITY OF SUCH DAMAGE.
39+
40+
newlib source code
41+
------------------
42+
43+
During building, the build system will download the newlib source code and
44+
build source code from the `newlib/libc` and `newlib/libm` directories. The
45+
code in this directories has a variety of licences, the details of which are
46+
explained in the `README.newlib` file in the root directory of the newlib code.

MAINTAINERS.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Maintainers List
2+
================
3+
4+
For notes on how to read this information, please refer to `MAINTAINERS.md` in
5+
the main Unikraft repository.
6+
7+
NEWLIB-UNIKRAFT
8+
M: Felipe Huici <[email protected]>
9+
M: Florian Schmidt <[email protected]>
10+
11+
F: *

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
newlib for Unikraft
2+
===================
3+
4+
Please refer to the `README.md` as well as the documentation in the `doc/`
5+
subdirectory of the main unikraft repository.

0 commit comments

Comments
 (0)