[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [UNIKRAFT/LIBHOGWEED v3 1/3] Add md files
Hi Dragos,
Looks good to me.
Signed-off-by: ARGINT DRAGOS IULIAN <dragosargint21@xxxxxxxxx>
---
.gitignore | 27 +++++++++++++++++++++++++++
CODING_STYLE.md | 4 ++++
CONTRIBUTING.md | 4 ++++
COPYING.md | 39 +++++++++++++++++++++++++++++++++++++++
MAINTAINERS.md | 11 +++++++++++
README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
6 files changed, 134 insertions(+)
create mode 100644 .gitignore
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
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..75d2fd3
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,27 @@
+*.depend
+*.o
+*.a
+*.d
+*.so
+*.orig
+*.rej
+*.bak
+*.swp
+*~
+,*
+\#*\#
+.\#*
+\#_*\#
+.\#_*
+!.gitignore
+.*
+
+# gnu global files
+GPATH
+GRTAGS
+GSYMS
+GTAGS
+
+# cscope files
+cscope.*
+ncscope.*
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..14f6ac6
--- /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..2595ad9
--- /dev/null
+++ b/COPYING.md
@@ -0,0 +1,39 @@
+License
+=======
+
+Unikraft libhogweed wrappers
+----------------------------------
+
+This repository contains wrapper code to build hogweed 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) Year, Institution. 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..6db09e2
--- /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.
+
+ LIBHOGWEED-UNIKRAFT
+ M: Argint Dragos Iulian <dragosargint21@xxxxxxxxx>
+ M: Felipe Huici <felipe.huici@xxxxxxxxx>
+ L: minios-devel@xxxxxxxxxxxxx
+ F: *
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3853914
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+Libhogweed for Unikraft
+=============================
+
+This is the port of nettle's libhogweed for Unikraft as external library.
+
+Libhogweed depends on newlib, so please make sure you add the following
+line to the `LIBS` variable in your `Makefile`:
+ `...:$(UK_LIBS)/newlib:$(UK_LIBS)/libhogweed:...`
+
+Testing
+-------
+
+For running the tests: enable the `testsuite` option in the configuration menu
+and select the desired tests. Make sure to include `testutils_glue.h` and call
+the `run_all_libhogweed_tests(v);` function in your main application. The parameter
+`v` stands for verbose and you can either set it to `0`, non verbose mode, or `1`,
+verbose mode.
+
+Applications
+------------
+
+To run an application that requires a filesystem, you'll need to run them on
+`kvm` and enable `9pfs`, selecting the following menu options, all of them under
+`Library Configuration`:
+- `libnewlib`
+- `libhogweed`
+- `vfscore: VFS Core Interface` ---> `vfscore: Configuration` --->
+ `Automatically mount a root filesystem` ---> `Default root filesystem`
+ ---> `9PFS`
+- `uk9p: 9p client`
+- `9pfs: 9p filesystem`
+- `devfs: devfs file system ---> Mount /dev during boot`
+- `ukswrand: Software random number generator ---> Register random and
+ urandom device to devfs`
+
+Mounting a file system
+---------------------
+In order to mount the file system you'll need to provide the following Qemu
+parameters:
+- `-fsdev local,id=myid,path=<some directory>,security_model=none`
+- `-device virtio-9p-pci,fsdev=myid,mount_tag=rootfs,disable-modern=on,
+ disable-legacy=off`
+
+Note that if you use a different `mount_tag`, you'll need to add it in `Default
+root device` in `vfscore configuration`. Also, to provide command line
+arguments to the kernel, you'll need to use `-append "param1 param2 ..."`.
+
+Please refer to the `README.md` as well as the documentation in the `doc/`
+subdirectory of the main unikraft repository.
--
2.17.1
|
