genode/repos/libports
Martin Stein f8953de7ac nic_router: replace term "uplink" with "NIC client"
BREAKS CONFIG COMPATIBILITY:
This commit changes the configuration interface of the NIC router in a way that
may break systems that use the component without proper adjustment!

HOW TO ADJUST:
At each occurrence of the '<uplink ...>' tag in a NIC router configuration
replace the tag name 'uplink' with 'nic-client'. The rest of the tag stays the
same.

The term "uplink" for network interfaces in the router that have a NIC session
client as back end was introduced in a time when Uplink sessions didn't yet
exist. Now, they do and, although both an uplink and an Uplink session
normally describe a network session between router and network device driver,
they are based on two different service types (NIC and Uplink). This can easily
cause confusion when integrating the router (the <uplink> is not related to
Uplink sessions) or trying to understand its functioning (an 'Uplink' object
has nothing to do with the Uplink service).

Therefore, this commit introduces the more specific term "NIC client" for an
interface that is based on a NIC session requested by the router. This doesn't
imply any semantic changes at the NIC router. However, the commit also brings a
broader update of the router's README and removes the term "downlink" that was
used only in documentation to refer to interfaces backed by a NIC session
provided by the router. The term was only associated with this meaning because
it is the natural counterpart to an uplink. This isn't appropriate anymore as
the terms for interface types have moved to a more technical level.

The commit adjusts all scenarios in the basic Genode repositories properly.

Fixes #4238
2021-08-18 15:06:11 +02:00
..
doc tool: remove deprecated 'make prepare' mechanism 2016-03-17 17:02:04 +01:00
include stdcxx: support /dev/urandom 2021-05-28 14:15:27 +02:00
lib libm: use libm from libc and remove openlibm 2021-07-28 11:25:21 +02:00
ports libuvc: add UVC 1.50 support 2021-07-28 11:27:04 +02:00
recipes depot: update recipe hashes 2021-07-28 11:27:05 +02:00
run nic_router: replace term "uplink" with "NIC client" 2021-08-18 15:06:11 +02:00
src qemu-usb/webcam: reset delay packet state 2021-07-28 11:27:04 +02:00
README README update 2016-08-30 17:24:00 +02:00

This directory contains ports of popular 3rd-party software to Genode.


Usage
-----

The tool './tool/ports/prepare_port' in the toplevel directory automates the
task of downloading and preparing the library source codes. You can select
individual packages that have to be prepared by specifying their base names
(without the version number) as command-line argument. For example, the
following command prepares both the C library and the Freetype library:
! ./tool/ports/prepare_port libc freetype

To compile and link against 3rd-party libraries of the 'libports' repository,
you have to include the repository into the build process by appending it to the
'REPOSITORIES' declaration of your '<build-dir>/etc/build.conf' file.


Under the hood
--------------

For each library, there is a file contained in the 'libports/ports/'
subdirectory. The file is named after the library and contains the
library-specific rules for downloading the source code and installing header
files.


How does 'libports' relate to the other repositories?
-----------------------------------------------------

Most libraries hosted in the 'libports' repository expect a complete C library,
which is provided with the 'libc' package. Please do not forget to prepare the
libc package when using any of the other libports packages. The libc, in turn,
depends on the 'os' repository for its back end. Because the 'os' repository is
the home of the dynamic linker, libraries contained in 'libports' are safe to
assume the presence of the dynamic linker and, thus, should be built as shared
libraries.