Discussion:
Minor language issues in documentation
Ben Gamari
2014-09-16 16:56:24 UTC
Permalink
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
Pablo Neira Ayuso
2014-09-17 08:54:06 UTC
Permalink
Post by 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].
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.
--
To unsubscribe from this list: send the line "unsubscribe netfilter" in
the body of a message to ***@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Loading...