[Minios-devel] [UNIKRAFT/LIBAXTLS PATCH 2/2] Add ddocumentation

[Felipe Huici <felipe.huici@xxxxxxxxx>]

Signed-off-by: Felipe Huici <felipe.huici@xxxxxxxxx>
---
 CODING_STYLE.md |  4 ++++
 CONTRIBUTING.md |  4 ++++
 COPYING.md      | 38 ++++++++++++++++++++++++++++++++++++++
 MAINTAINERS.md  | 10 ++++++++++
 Makefile.uk     |  8 +-------
 README.md       | 16 ++++++++++++++++
 glue.c          | 12 ------------
 7 files changed, 73 insertions(+), 19 deletions(-)
 create mode 100644 CODING_STYLE.md
 create mode 100644 CONTRIBUTING.md
 create mode 100644 COPYING.md
 create mode 100644 MAINTAINERS.md
 create mode 100644 README.md
 delete mode 100644 glue.c

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..24cf7c1
--- /dev/null
+++ b/COPYING.md
@@ -0,0 +1,38 @@
+License
+=======
+
+Unikraft axtls wrappers
+------------------------
+
+This repository contains wrapper code to build libuuid with Unikraft.
+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) 2019, 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.
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
new file mode 100644
index 0000000..6a2f0e2
--- /dev/null
+++ b/MAINTAINERS.md
@@ -0,0 +1,10 @@
+Maintainers List
+================
+
+For notes on how to read this information, please refer to `MAINTAINERS.md` in
+the main Unikraft repository.
+
+       AXTLS-UNIKRAFT
+       M:      Felipe Huici <felipe.huici@xxxxxxxxx>
+       L:      minios-devel@xxxxxxxxxxxxx
+       F: *
diff --git a/Makefile.uk b/Makefile.uk
index cf513a0..4fd68db 100644
--- a/Makefile.uk
+++ b/Makefile.uk
@@ -1,8 +1,7 @@
-#  libaxtls Makefile.uc
+#  libaxtls Makefile.uk
 #
 #  Authors: Felipe Huici <felipe.huici@xxxxxxxxx>
 #
-#
 #  Copyright (c) 2019, NEC Europe Ltd., NEC Corporation. All rights reserved.
 #
 #  Redistribution and use in source and binary forms, with or without
@@ -83,11 +82,6 @@ LIBAXTLS_CFLAGS-y   += $(SUPPRESS_FLAGS)
 LIBAXTLS_CXXFLAGS-y += $(SUPPRESS_FLAGS)
 
 
################################################################################
-# OS dependencies code - Glue between Unikfraft and axtls
-################################################################################
-LIBAXTLS_SRCS-y += $(LIBAXTLS_BASE)/glue.c
-
-################################################################################
 # axtls code - crypto
 
################################################################################
 LIBAXTLS_SRCS-y += $(LIBAXTLS_SRC)/crypto/aes.c
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d12786c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+axtls for Unikraft
+===================
+This is the port of axtls for Unikraft as external library. You will
+need lwip to make it work. 
+
+To run ssltest.c as a unit test, you'll need pthread support, e.g.,
+add the following line to the LIBS variable in the Makefile:
+
+   ...$(UK_LIBS)/lwip:$(UK_LIBS)/pthread-embedded:
+      $(UK_LIBS)/newlib:$(UK_LIBS)/axtls...
+
+Note that you'll need a filesystem in place and the certificate files for
+all tests to pass.
+
+Please refer to the `README.md` as well as the documentation in the `doc/`
+subdirectory of the main unikraft repository.
diff --git a/glue.c b/glue.c
deleted file mode 100644
index 7138f9d..0000000
--- a/glue.c
+++ /dev/null
@@ -1,12 +0,0 @@
-/* According to POSIX.1-2001, POSIX.1-2008 */
-#include <sys/select.h>
-
-/* According to earlier standards */
-#include <sys/time.h>
-#include <sys/types.h>
-#include <unistd.h>
-
-int select(int nfds, fd_set *readfds, fd_set *writefds,
-          fd_set *exceptfds, struct timeval *timeout) {
-       return -1;
-}
-- 
2.11.0


_______________________________________________
Minios-devel mailing list
Minios-devel@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/mailman/listinfo/minios-devel