Re: [Minios-devel] [UNIKRAFT/LIBPSIMD PATCH 2/3] Add documentation

[Felipe Huici <Felipe.Huici@xxxxxxxxx>]

Hi Vlad,

This patch looks good. The only thing is that it might be good to list external 
lib depedencies (i.e., the LIBS:= line that goes in the application Makefile) 
in README.md. I know we haven't done this in the past, but right now the only 
"documentation" of this is in the commit logs, which isn't very user-friendly. 
I can add this on usptreaming though.

-- Felipe

Reviewed-by: Felipe Huici <felipe.huici@xxxxxxxxx>

On 25.06.19, 21:50, "Vlad-Andrei BĂDOIU (78692)" 
<vlad_andrei.badoiu@xxxxxxxxxxxxxxx> wrote:

    Signed-off-by: Vlad-Andrei Badoiu <vlad_andrei.badoiu@xxxxxxxxxxxxxxx>
    ---
     CODING_STYLE.md |  4 ++++
     CONTRIBUTING.md |  4 ++++
     COPYING.md      | 31 +++++++++++++++++++++++++++++++
     MAINTAINERS.md  | 11 +++++++++++
     README.md       |  5 +++++
     5 files changed, 55 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..7ef11d1
    --- /dev/null
    +++ b/COPYING.md
    @@ -0,0 +1,31 @@
    +License
    +=======
    +
    +Unikraft libpsimd wrappers
    +-----------------------
    +
    +This repository contains wrapper code to build psimd 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. University Politehnica of Bucharest. 
    +   All rights reserved.
    +   
    +   This library is free software; you can redistribute it and/or
    +   modify it under the terms of the GNU Lesser General Public
    +   License as published by the Free Software Foundation; either
    +   version 2 of the License, or (at your option) any later version.
    +   
    +   This library is distributed in the hope that it will be useful,
    +   but WITHOUT ANY WARRANTY; without even the implied warranty of
    +   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    +   Lesser General Public License for more details.
    +   
    +   You should have received a copy of the GNU Lesser General Public
    +   License along with this library in the file COPYING.LIB;
    +   if not, write to the Free Software Foundation, Inc.,
    +   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
    +
    diff --git a/MAINTAINERS.md b/MAINTAINERS.md
    new file mode 100644
    index 0000000..09f326c
    --- /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.
    +
    +   LIBPSIMD-UNIKRAFT
    +   M:      Felipe Huici <felipe.huici@xxxxxxxxx>
    +   M:      Vlad-Andrei Badoiu <vlad_andrei.badoiu@xxxxxxxxxxxxxxx>
    +   L:      minios-devel@xxxxxxxxxxxxx
    +   F: *
    diff --git a/README.md b/README.md
    new file mode 100644
    index 0000000..25905c0
    --- /dev/null
    +++ b/README.md
    @@ -0,0 +1,5 @@
    +libpsimd for Unikraft
    +===================
    +
    +Please refer to the `README.md` as well as the documentation in the `doc/`
    +subdirectory of the main unikraft repository.
    -- 
    2.21.0
    
    

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