Move the modified 3-Clause BSD text into LICENSE

This is to help the automated license detectors find the text without
getting confused by the surrounding verbiage. However the text has
is lightly modified from the reference 3-clause text I checked on:

  https://opensource.org/license/bsd-3-clause

As it adds:

  "All rights reserved" on the copyright line
  Mentions DANNY GASPAROVSKI in place of COPYRIGHT HOLDERS
  Uses `` and '' to wrap "AS IS"

Which results in the golang license detector only having 96%
confidence this is a BSD-3-Clause. Before this patch it was 89%
confident. However these seems enough to convince GitLab to properly
categorise the license of the project.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
2 files changed
tree: d1ebab5a8c2cb6ce24616583f216f8481d131351
  1. build-aux/
  2. fuzzing/
  3. src/
  4. test/
  5. .clang-format
  6. .gitignore
  7. .gitlab-ci.yml
  8. .gitpublish
  9. CHANGELOG.md
  10. COPYRIGHT
  11. LICENSE
  12. meson.build
  13. meson_options.txt
  14. README.md
README.md

libslirp

libslirp is a user-mode networking library used by virtual machines, containers or various tools.

Getting Started

Prerequisites

A C compiler, meson and glib2 development libraries.

(see also .gitlab-ci.yml DEPS variable for the list of dependencies on Fedora)

Building

You may build and install the shared library with meson:

meson build
ninja -C build install

And configure QEMU with --enable-slirp=system to link against it.

(QEMU may build with the submodule static library using --enable-slirp=git)

Testing

Unfortunately, there are no automated tests available.

You may run QEMU -net user linked with your development version.

Contributing

Feel free to open issues on the project issues page.

You may clone the gitlab project and create a merge request.

Contributing with gitlab allows gitlab workflow, tracking issues, running CI etc.

Alternatively, you may send patches to slirp@lists.freedesktop.org mailing list.

Debugging

To make slirp emit debugging prints, one can use for instance:

export G_MESSAGES_DEBUG=Slirp
export SLIRP_DEBUG=call

SLIRP_DEBUG can contain a colons/spaces/commas-separated list of call, misc, error, tftp, verbose_call

Versioning

We intend to use libtool's versioning for the shared libraries and use SemVer for project versions.

For the versions available, see the tags on this repository.

License

See the COPYRIGHT file for details.