diff mbox series

[nft] doc/nft.xml: mention nftables earlier

Message ID 151636426787.19915.2075416375709343233.stgit@endurance
State Accepted
Delegated to: Pablo Neira
Headers show
Series [nft] doc/nft.xml: mention nftables earlier | expand

Commit Message

Arturo Borrero Gonzalez Jan. 19, 2018, 12:17 p.m. UTC 
Mention nftables earlier in the documentation, so users have more context on what
we are talking about.

This is Debian bug #887718, which contains:

<<<
Currently one must read down 100 lines before it is even mentioned.
You might want to make the connection between "nft" and "nftables" as
early as the NAME or DESCRIPTION.
>>>

Requested-by: Dan Jacobson <jidanni@jidanni.org>
Signed-off-by: Arturo Borrero Gonzalez <arturo@netfilter.org>
---
 doc/nft.xml |    7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)


--
To unsubscribe from this list: send the line "unsubscribe netfilter-devel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Pablo Neira Ayuso Jan. 19, 2018, 12:49 p.m. UTC | #1 
On Fri, Jan 19, 2018 at 01:17:47PM +0100, Arturo Borrero Gonzalez wrote:
> Mention nftables earlier in the documentation, so users have more context on what
> we are talking about.
> 
> This is Debian bug #887718, which contains:
> 
> <<<
> Currently one must read down 100 lines before it is even mentioned.
> You might want to make the connection between "nft" and "nftables" as
> early as the NAME or DESCRIPTION.
> >>>

Applied, thanks Arturo.
--
To unsubscribe from this list: send the line "unsubscribe netfilter-devel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox series

Patch

diff --git a/doc/nft.xml b/doc/nft.xml
index e515b11..9e979af 100644
--- a/doc/nft.xml
+++ b/doc/nft.xml
@@ -38,7 +38,7 @@  vi:ts=4 sw=4
 	<refnamediv>
 		<refname>nft</refname>
 		<refpurpose>
-			Administration tool for packet filtering and classification
+			Administration tool of the nftables framework for packet filtering and classification
 		</refpurpose>
 	</refnamediv>
 
@@ -73,8 +73,9 @@  vi:ts=4 sw=4
 	<refsect1>
 		<title>Description</title>
 		<para>
-			nft is used to set up, maintain and inspect packet
-			filtering and classification rules in the Linux kernel.
+			nft is the command line tool used to set up, maintain and inspect packet
+			filtering and classification rules in the Linux kernel, in the nftables framework.
+			The Linux kernel subsystem is known as nf_tables, and 'nf' stands for Netfilter.
 		</para>
 	</refsect1>