From: Stefano Brivio <sbrivio@redhat.com>
To: passt-dev@passt.top
Subject: [PATCH 18/24] README: Avoid "here" links
Date: Fri, 25 Mar 2022 23:52:54 +0100 [thread overview]
Message-ID: <20220325225300.2803584-19-sbrivio@redhat.com> (raw)
In-Reply-To: <20220325225300.2803584-1-sbrivio@redhat.com>
[-- Attachment #1: Type: text/plain, Size: 4471 bytes --]
They look a bit lame: rephrase sentences to avoid them.
Signed-off-by: Stefano Brivio <sbrivio(a)redhat.com>
---
README.md | 39 +++++++++++++++++++--------------------
1 file changed, 19 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
index 8e07fb1..632ddd1 100644
--- a/README.md
+++ b/README.md
@@ -221,8 +221,9 @@ is needed as _passt_ runs without the `CAP_NET_RAW` capability: it can't create
raw IP sockets on the pod, and therefore needs to map packets at Layer-2 to
Layer-4 sockets offered by the host kernel.
-The problem and this approach are illustrated in more detail, with diagrams,
-[here](https://gitlab.com/abologna/kubevirt-and-kvm/-/blob/master/Networking.md).
+See also a
+[detailed illustration](https://gitlab.com/abologna/kubevirt-and-kvm/-/blob/master/Networking.md)
+of the problem and what lead to this approach.
### pasta
@@ -294,8 +295,8 @@ speeding up local connections, and usually requiring NAT. _pasta_:
* 🛠️ ~5 000 LoC target
* ⌚ [fuzzing](https://bugs.passt.top/show_bug.cgi?id=9), _packetdrill_ tests
* ⌚ stricter [synflood protection](https://bugs.passt.top/show_bug.cgi?id=10)
-* 💡 [your](https://lists.passt.top/) [ideas](https://bugs.passt.top/)
- [here](https://chat.passt.top)
+* 💡 [add](https://lists.passt.top/) [your](https://bugs.passt.top/)
+ [ideas](https://chat.passt.top)
### Configurability
* ✅ all addresses, ports, port ranges
@@ -304,8 +305,8 @@ speeding up local connections, and usually requiring NAT. _pasta_:
* ✅ _pasta_: auto-detection of bound ports
* 🛠 run-time configuration of port ranges without autodetection
* 🛠 configuration of port ranges for autodetection
-* 💡 [your](https://lists.passt.top/) [ideas](https://bugs.passt.top/)
- [here](https://chat.passt.top)
+* 💡 [add](https://lists.passt.top/) [your](https://bugs.passt.top/)
+ [ideas](https://chat.passt.top)
### Performance
* ✅ maximum two (cache hot) copies on every data path
@@ -416,9 +417,9 @@ destination address translated to the loopback address.
## Protocols
_passt_ and _pasta_ support TCP, UDP and ICMP/ICMPv6 echo (requests and
-replies). More details about the TCP implementation are available
-[here](/passt/tree/tcp.c), and for the UDP
-implementation [here](/passt/tree/udp.c).
+replies). More details about the TCP implementation are described in the
+[theory of operation](/passt/tree/tcp.c), and similarly for
+[UDP](/passt/tree/udp.c).
An IGMP/MLD proxy is currently work in progress.
@@ -506,7 +507,7 @@ if (getComputedStyle(document.getElementById('ci'))['visibility'] == "visible")
<p><a href="/builds/latest/web/ci.html">Continuous integration test run</a></p>
</div>
-Test logs [here](/builds/latest/test/).
+See also the [test logs](/builds/latest/test/).
## Performance
@@ -522,11 +523,10 @@ Test logs [here](/builds/latest/test/).
cd passt
make
- * alternatively, static builds for x86_64 as of the latest commit are also
- available for convenience [here](/builds/latest/x86_64/). Convenience,
- non-official packages for Debian (and derivatives) and RPM-based
- distributions are also available there. These binaries and packages are
- simply built with:
+ * alternatively, [static builds]((/builds/latest/x86_64/) for x86_64 as of
+ the latest commit are also available for convenience. Non-official
+ packages for Debian (and derivatives) and RPM-based distributions are also
+ available there. These binaries and packages are simply built with:
make pkgs
@@ -581,11 +581,10 @@ Test logs [here](/builds/latest/test/).
cd passt
make
- * alternatively, static builds for x86_64 as of the latest commit are also
- available for convenience [here](/builds/latest/x86_64/). Convenience,
- non-official packages for Debian (and derivatives) and RPM-based
- distributions are also available there. These binaries and packages are
- simply built with:
+ * alternatively, [static builds]((/builds/latest/x86_64/) for x86_64 as of
+ the latest commit are also available for convenience. Non-official
+ packages for Debian (and derivatives) and RPM-based distributions are also
+ available there. These binaries and packages are simply built with:
make pkgs
--
@@ -221,8 +221,9 @@ is needed as _passt_ runs without the `CAP_NET_RAW` capability: it can't create
raw IP sockets on the pod, and therefore needs to map packets at Layer-2 to
Layer-4 sockets offered by the host kernel.
-The problem and this approach are illustrated in more detail, with diagrams,
-[here](https://gitlab.com/abologna/kubevirt-and-kvm/-/blob/master/Networking.md).
+See also a
+[detailed illustration](https://gitlab.com/abologna/kubevirt-and-kvm/-/blob/master/Networking.md)
+of the problem and what lead to this approach.
### pasta
@@ -294,8 +295,8 @@ speeding up local connections, and usually requiring NAT. _pasta_:
* 🛠️ ~5 000 LoC target
* ⌚ [fuzzing](https://bugs.passt.top/show_bug.cgi?id=9), _packetdrill_ tests
* ⌚ stricter [synflood protection](https://bugs.passt.top/show_bug.cgi?id=10)
-* 💡 [your](https://lists.passt.top/) [ideas](https://bugs.passt.top/)
- [here](https://chat.passt.top)
+* 💡 [add](https://lists.passt.top/) [your](https://bugs.passt.top/)
+ [ideas](https://chat.passt.top)
### Configurability
* ✅ all addresses, ports, port ranges
@@ -304,8 +305,8 @@ speeding up local connections, and usually requiring NAT. _pasta_:
* ✅ _pasta_: auto-detection of bound ports
* 🛠 run-time configuration of port ranges without autodetection
* 🛠 configuration of port ranges for autodetection
-* 💡 [your](https://lists.passt.top/) [ideas](https://bugs.passt.top/)
- [here](https://chat.passt.top)
+* 💡 [add](https://lists.passt.top/) [your](https://bugs.passt.top/)
+ [ideas](https://chat.passt.top)
### Performance
* ✅ maximum two (cache hot) copies on every data path
@@ -416,9 +417,9 @@ destination address translated to the loopback address.
## Protocols
_passt_ and _pasta_ support TCP, UDP and ICMP/ICMPv6 echo (requests and
-replies). More details about the TCP implementation are available
-[here](/passt/tree/tcp.c), and for the UDP
-implementation [here](/passt/tree/udp.c).
+replies). More details about the TCP implementation are described in the
+[theory of operation](/passt/tree/tcp.c), and similarly for
+[UDP](/passt/tree/udp.c).
An IGMP/MLD proxy is currently work in progress.
@@ -506,7 +507,7 @@ if (getComputedStyle(document.getElementById('ci'))['visibility'] == "visible")
<p><a href="/builds/latest/web/ci.html">Continuous integration test run</a></p>
</div>
-Test logs [here](/builds/latest/test/).
+See also the [test logs](/builds/latest/test/).
## Performance
@@ -522,11 +523,10 @@ Test logs [here](/builds/latest/test/).
cd passt
make
- * alternatively, static builds for x86_64 as of the latest commit are also
- available for convenience [here](/builds/latest/x86_64/). Convenience,
- non-official packages for Debian (and derivatives) and RPM-based
- distributions are also available there. These binaries and packages are
- simply built with:
+ * alternatively, [static builds]((/builds/latest/x86_64/) for x86_64 as of
+ the latest commit are also available for convenience. Non-official
+ packages for Debian (and derivatives) and RPM-based distributions are also
+ available there. These binaries and packages are simply built with:
make pkgs
@@ -581,11 +581,10 @@ Test logs [here](/builds/latest/test/).
cd passt
make
- * alternatively, static builds for x86_64 as of the latest commit are also
- available for convenience [here](/builds/latest/x86_64/). Convenience,
- non-official packages for Debian (and derivatives) and RPM-based
- distributions are also available there. These binaries and packages are
- simply built with:
+ * alternatively, [static builds]((/builds/latest/x86_64/) for x86_64 as of
+ the latest commit are also available for convenience. Non-official
+ packages for Debian (and derivatives) and RPM-based distributions are also
+ available there. These binaries and packages are simply built with:
make pkgs
--
2.35.1
next prev parent reply other threads:[~2022-03-25 22:52 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-25 22:52 [PATCH 00/24] Boundary-checked "packets", TCP timerfd timeouts, assorted fixes Stefano Brivio
2022-03-25 22:52 ` [PATCH 01/24] conf, util, tap: Implement --trace option for extra verbose logging Stefano Brivio
2022-03-25 22:52 ` [PATCH 02/24] pcap: Fix mistake in printed string Stefano Brivio
2022-03-25 22:52 ` [PATCH 03/24] util: Drop CHECK_SET_MIN_MAX{,_PROTO_FD} macros Stefano Brivio
2022-03-25 22:52 ` [PATCH 04/24] util: Use standard int types Stefano Brivio
2022-03-25 22:52 ` [PATCH 05/24] tcp: Refactor to use events instead of states, split out spliced implementation Stefano Brivio
2022-03-25 22:52 ` [PATCH 06/24] test/lib/video: Fill in href attributes of video shortcuts Stefano Brivio
2022-03-25 22:52 ` [PATCH 07/24] udp: Drop _splice from recv, send, sendto static buffer names Stefano Brivio
2022-03-25 22:52 ` [PATCH 08/24] udp: Split buffer queueing/writing parts of udp_sock_handler() Stefano Brivio
2022-03-25 22:52 ` [PATCH 09/24] dhcpv6, tap, tcp: Use IN6_ARE_ADDR_EQUAL instead of open-coded memcmp() Stefano Brivio
2022-03-25 22:52 ` [PATCH 10/24] udp: Use flags for local, loopback, and configured unicast binds Stefano Brivio
2022-03-25 22:52 ` [PATCH 11/24] Makefile: Enable a few hardening flags Stefano Brivio
2022-03-25 22:52 ` [PATCH 12/24] test: Add asciinema(1) as requirement for CI in README Stefano Brivio
2022-03-25 22:52 ` [PATCH 13/24] test, seccomp, Makefile: Switch to valgrind runs for passt functional tests Stefano Brivio
2022-03-25 22:52 ` [PATCH 14/24] tcp, udp, util: Enforce 24-bit limit on socket numbers Stefano Brivio
2022-03-25 22:52 ` [PATCH 15/24] tcp: Rework timers to use timerfd instead of periodic bitmap scan Stefano Brivio
2022-03-25 22:52 ` [PATCH 16/24] tcp_splice: Close sockets right away on high number of open files Stefano Brivio
2022-03-25 22:52 ` [PATCH 17/24] test/perf: Work-around for virtio_net hang before long streams from guest Stefano Brivio
2022-03-25 22:52 ` Stefano Brivio [this message]
2022-03-25 22:52 ` [PATCH 19/24] README: Update Interfaces and Availability sections Stefano Brivio
2022-03-25 22:52 ` [PATCH 20/24] tcp: Fit struct tcp_conn into a single 64-byte cacheline Stefano Brivio
2022-03-25 22:52 ` [PATCH 21/24] dhcp: Minimum option length implied by RFC 951 is 60 bytes, not 62 Stefano Brivio
2022-03-25 22:52 ` [PATCH 22/24] tcp, tcp_splice: Use less awkward syntax to swap in/out sockets from pools Stefano Brivio
2022-03-25 22:52 ` [PATCH 23/24] util: Fix function declaration style of write_pidfile() Stefano Brivio
2022-03-25 22:53 ` [PATCH 24/24] treewide: Packet abstraction with mandatory boundary checks Stefano Brivio
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220325225300.2803584-19-sbrivio@redhat.com \
--to=sbrivio@redhat.com \
--cc=passt-dev@passt.top \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://passt.top/passt
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for IMAP folder(s).