Skip to contentSkip to conversation

Minor language issues in documentation

DISCUSSION Ben Gamari 2 participants 2 messages Sep 16, 2014 – Sep 17, 2014

lore
Share & tools
lore

Ben Gamari

author
#0 lore raw

Hello all,

While browsing the nftables documentation I noticed that the word "performance" is often misused in a variety of ways. For instance, on the main page[1],

Fast lookups through performance data structures: The new syntax allows you to arrange you rule-set in a very performance way contrary to purely linear-list based filtering policies.

The use in the first sentence might be acceptable as a colloquialism but really could be improved by replacing "performance" with "high performance".

The second sentence is a bit more serious as it uses "performance", a noun, as an adjective. You might consider replacing this with "performance-oriented" or a similar rewrite. I've found this same mix-up in a few other places as well[2].

I also noticed a couple other small issues,

* [3] misspells "hybrid"
* The "Basic operational" section of the documentation ToC would be named "Basic operation"

Otherwise thanks for the great packet mangling framework and thorough documentation!

Cheers,

- Ben

[1] http://www.netfilter.org/projects/nftables/
[2] http://wiki.nftables.org/wiki-nftables/index.php/Main_differences_with_iptables
[3] http://wiki.nftables.org/wiki-nftables/index.php/Configuring_tables

#1 lore raw
Quoted 20 lines · Ben Gamari

Hello all,

While browsing the nftables documentation I noticed that the word "performance" is often misused in a variety of ways. For instance, on the main page[1],

Fast lookups through performance data structures: The new syntax allows you to arrange you rule-set in a very performance way contrary to purely linear-list based filtering policies.

The use in the first sentence might be acceptable as a colloquialism but really could be improved by replacing "performance" with "high performance".

The second sentence is a bit more serious as it uses "performance", a noun, as an adjective. You might consider replacing this with "performance-oriented" or a similar rewrite. I've found this same mix-up in a few other places as well[2].

Quoted 8 lines

I also noticed a couple other small issues,

* [3] misspells "hybrid"
* The "Basic operational" section of the documentation ToC would be named "Basic operation"

Otherwise thanks for the great packet mangling framework and thorough documentation!

I have fixed what you indicated in the nftables wiki. Thanks.