Re: [Minios-devel] [UNIKRAFT PATCH V3 1/6] external plat: Add basic documentations.

[Felipe Huici <Felipe.Huici@xxxxxxxxx>]

Hi Haibo,

Thanks for the patch, a couple of comments (and please also see inline):

* There are a lot of copy & paste errors (newlib instead of solo5, the 
maintainers list, etc.) in this patch. 
* The copyright year should be 2019
* Please add just a bit of documentation to README.md on how to use the results 
of the build (i.e., at least the syntax for the solo5-hvt command.

Thanks!

-- Felipe

On 16.08.19, 04:59, "Minios-devel on behalf of Haibo Xu" 
<minios-devel-bounces@xxxxxxxxxxxxxxxxxxxx on behalf of haibo.xu@xxxxxxx> wrote:

    Signed-off-by: Haibo Xu <haibo.xu@xxxxxxx>
    ---
     CODING_STYLE.md |  4 ++++
     CONTRIBUTING.md |  4 ++++
     COPYING.md      | 46 ++++++++++++++++++++++++++++++++++++++++++++++
     MAINTAINERS.md  | 11 +++++++++++
     README.md       |  5 +++++
     5 files changed, 70 insertions(+)
     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/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

Should be solo5

    +------------------------
    +
    +This repository contains wrapper code to build newlib with Unikraft.  The 
code

Change to describe solo5

    +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.

Update year

    +
    +   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

Should be solo5

    +------------------
    +
    +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

Change to describe solo5

    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 <felipe.huici@xxxxxxxxx>
    +   M:      Florian Schmidt <florian.schmidt@xxxxxxxxx>
    +   L:      minios-devel@xxxxxxxxxxxxx

These are newlib's maintainers

    +   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

Should be solo5

    +===================
    +
    +Please refer to the `README.md` as well as the documentation in the `doc/`
    +subdirectory of the main unikraft repository.

Please include some documentation on how to use the results of the build.

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

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