zephyr/samples/net/lldp
Ulf Magnusson bd6e04411e kconfig: Clean up header comments and make them consistent
Use this short header style in all Kconfig files:

    # <description>

    # <copyright>
    # <license>

    ...

Also change all <description>s from

    # Kconfig[.extension] - Foo-related options

to just

    # Foo-related options

It's clear enough that it's about Kconfig.

The <description> cleanup was done with this command, along with some
manual cleanup (big letter at the start, etc.)

    git ls-files '*Kconfig*' | \
        xargs sed -i -E '1 s/#\s*Kconfig[\w.-]*\s*-\s*/# /'

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-04 17:31:27 -05:00
..
src
CMakeLists.txt
Kconfig kconfig: Clean up header comments and make them consistent 2019-11-04 17:31:27 -05:00
README.rst
prj.conf
sample.yaml

README.rst

.. _lldp-sample:

LLDP Sample Application
#######################

Overview
********

The Link Layer Discovery Protocol sample application for Zephyr will enable
LLDP support and setup VLANs if needed.

The source code for this sample application can be found at:
:zephyr_file:`samples/net/lldp`.

Requirements
************

- :ref:`networking_with_host`

Building and Running
********************

A good way to run this sample LLDP application is inside QEMU,
as described in :ref:`networking_with_qemu` or with embedded device like
FRDM-K64F. Note that LLDP is only supported for boards that have an ethernet
port.

Follow these steps to build the LLDP sample application:

.. zephyr-app-commands::
   :zephyr-app: samples/net/lldp
   :board: <board to use>
   :conf: prj.conf
   :goals: build
   :compact:

Setting up Linux Host
=====================

If you need VLAN support in your network, then the
:zephyr_file:`samples/net/vlan/vlan-setup-linux.sh` provides a script that can be
executed on the Linux host. It creates two VLANs on the Linux host and creates
routes to Zephyr.