Re: [Minios-devel] [UNIKRAFT/SQLITE V3 PATCH 1/5] Introduce library skeleton

[Costin Lupu <costin.lup@xxxxxxxxx>]

Hi Gaulthier,

Please see inline.

On 12/4/19 7:52 PM, Gaulthier Gain wrote:
> We use the BSD-3-Clause license for this library glue code.
> 
> Signed-off-by: Gaulthier Gain <gaulthier.gain@xxxxxxxxx>
> ---
>  .gitignore      | 27 +++++++++++++++++++++++++++
>  CODING_STYLE.md |  4 ++++
>  CONTRIBUTING.md |  4 ++++
>  COPYING.md      | 38 ++++++++++++++++++++++++++++++++++++++
>  Config.uk       | 14 ++++++++++++++
>  MAINTAINERS.md  | 11 +++++++++++
>  README.md       | 23 +++++++++++++++++++++++
>  7 files changed, 121 insertions(+)
>  create mode 100644 .gitignore
>  create mode 100644 CODING_STYLE.md
>  create mode 100644 CONTRIBUTING.md
>  create mode 100644 COPYING.md
>  create mode 100644 Config.uk
>  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..90af952
> --- /dev/null
> +++ b/COPYING.md
> @@ -0,0 +1,38 @@
> +License
> +=======
> +
> +Unikraft SQLite wrappers
> +----------------------------------
> +
> +This repository contains wrapper code to build SQLite 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/Config.uk b/Config.uk
> new file mode 100644
> index 0000000..47e613f
> --- /dev/null
> +++ b/Config.uk
> @@ -0,0 +1,14 @@
> +### Invisible option for dependencies

What's the deal with this comment? :-)

> +menuconfig LIBSQLITE
> +    bool "SQLite"
> +    default y
> +    select LIBUKMMAP
> +    select UKSYSINFO
> +    select LIBNEWLIBC
> +    select LIBPTHREAD_EMBEDDED
> +
> +if LIBSQLITE
> +config LIBSQLITE_MAIN_FUNCTION
> +    bool "Provide main function"
> +    default y

Please add this configuration option when you introduce the main() function.

> +endif
> diff --git a/MAINTAINERS.md b/MAINTAINERS.md
> new file mode 100644
> index 0000000..7c13ed9
> --- /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.
> +
> +     LIBSQLITE-UNIKRAFT
> +     M:  Gaulthier Gain <gaulthier.gain@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..9d7c55c
> --- /dev/null
> +++ b/README.md
> @@ -0,0 +1,23 @@
> +SQLite for Unikraft
> +=============================
> +
> +This is the port of SQLite for Unikraft as external library. By
> +default, the SQLite shell is launched. You can modify this behaviour
> +by updating the `main()` function provided in the SQLite glue code.
> +
> +## Build
> +SQLite depends on the following libraries, that need to be added to
> +`Makefile` in this order:
> +
> +* `pthreads`, e.g. `pthread-embedded`
> +* `libc`, e.g. `newlib`
> +
> +## Root filesystem
> +
> +To import/export databases and/or csv files, it is necessary to have
> +a filesystem. The steps for creating and using a filesystem are the
> +same as the ones used for 
> [nginx](https://github.com/unikraft/lib-nginx/blob/staging/README.md).

Ideally, this patch which introduces the skeleton doesn't add the extra
info in README. The extra info is usually introduced in a later patch.
But I don't feel strong about this.

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

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