Skip to content

Commit 3c3627b

Browse files
kartbennashif
authored andcommitted
samples: net: vlan: improve README formatting
simple tweaks to improve HTML rendering of the vLAN README Signed-off-by: Benjamin Cabé <[email protected]>
1 parent dea2bcb commit 3c3627b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

samples/net/vlan/README.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Building and Running
2222
********************
2323

2424
A good way to run this VLAN application is with QEMU as described in
25-
:ref:`networking_with_eth_qemu`. You can use *zeth-vlan.conf* configuration
26-
file when running *net-setup.sh* script in Linux like this:
25+
:ref:`networking_with_eth_qemu`. You can use :file:`zeth-vlan.conf` configuration
26+
file when running :file:`net-setup.sh` script in Linux like this:
2727

2828
.. code-block:: console
2929
@@ -41,8 +41,8 @@ Follow these steps to build the VLAN sample application:
4141
:goals: build
4242
:compact:
4343

44-
The default configuration file prj.conf creates two virtual LAN networks
45-
with these settings:
44+
The default configuration file :zephyr_file:`samples/net/vlan/prj.conf` creates
45+
two virtual LAN networks with these settings:
4646

4747
- VLAN tag 100: IPv4 198.51.100.1 and IPv6 2001:db8:100::1
4848
- VLAN tag 200: IPv4 203.0.113.1 and IPv6 2001:db8:200::1
@@ -51,8 +51,8 @@ Setting up Linux Host
5151
=====================
5252

5353
The :zephyr_file:`samples/net/vlan/vlan-setup-linux.sh` provides a script that
54-
can be executed on the Linux host. It creates two VLAN interfaces *vlan.100*
55-
and *vlan.200* on the Linux host and creates routes to Zephyr.
54+
can be executed on the Linux host. It creates two VLAN interfaces ``vlan.100``
55+
and ``vlan.200`` on the Linux host and creates routes to Zephyr.
5656

5757
If everything is configured correctly, you will be able to successfully execute
5858
the following commands on the Linux host.
@@ -64,6 +64,6 @@ the following commands on the Linux host.
6464
ping -c 1 2001:db8:200::1
6565
ping -c 1 203.0.113.1
6666
67-
The network packets to *2001:db8:100::1* or *198.51.100.1* will have VLAN
67+
The network packets to ``2001:db8:100::1`` or ``198.51.100.1`` will have VLAN
6868
tag 100 set to them. The vlan tag 200 will be set to network packets to
69-
*2001:db8:200::1* or *203.0.113.1*.
69+
``2001:db8:200::1`` or ``203.0.113.1``.

0 commit comments

Comments
 (0)