From patchwork Tue Jul 31 13:34:33 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Arushi Singhal X-Patchwork-Id: 951597 X-Patchwork-Delegate: pablo@netfilter.org Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netfilter-devel-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="s+F+epbw"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 41fy8x0twcz9rvt for ; Tue, 31 Jul 2018 23:34:41 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1732190AbeGaPPB (ORCPT ); Tue, 31 Jul 2018 11:15:01 -0400 Received: from mail-pf1-f179.google.com ([209.85.210.179]:45764 "EHLO mail-pf1-f179.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1732110AbeGaPPA (ORCPT ); Tue, 31 Jul 2018 11:15:00 -0400 Received: by mail-pf1-f179.google.com with SMTP id i26-v6so6121466pfo.12 for ; Tue, 31 Jul 2018 06:34:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=date:from:to:cc:subject:message-id:mime-version:content-disposition :user-agent; bh=JCYd+gL9zXDb7T2F+pQgO6toy4HPdP3+caKHqQ+5PWM=; b=s+F+epbwsjt+VkuFkiOVkNvtzVM4OizwlpuCFWi7rgCl6nbtJ29Z89kbd49zyfkNyl BP/aKA8HGSWS9G9Sle5MTX5wP5Ocw6gwK9D/ouQDgOofaxYSuzf2upV3Pwlf8bQtGtjp 8AN7Jqkba9bikDNmTl5WsYayTNKmGlQEFLRNEuoZW42YqDMwriMfbgHL/Piaz1F8dvac YJNtwlRqAhGYPSESo19eBCOr0Pqx7ScqtFg1y4HnKO5EoY8tXLas+gVFkBxWQUptxtbE EUdbycM4nsmZ9sMug8FASXoYHux7Nc0GxrAjgYKFyz80WXogGdDPHz4wRwq3VIwe2faR fK1Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:mime-version :content-disposition:user-agent; bh=JCYd+gL9zXDb7T2F+pQgO6toy4HPdP3+caKHqQ+5PWM=; b=BxBbQ7I7JvH55PCVFQZAlDXEHlbR85VhAviRPIU9m2mO8EIwQVdBFpFXkxOzgxI1gc 1lBzTjfyhxfXUfs9N3xTZK9AzS+f/wKAqtjwt87tTTl/BgLCTXe+2tjo0chWrIA8Qv+L 9SVufe2y0bF+GqIhrfYexMankGI8NU1124aTT4Outc68KMSdNzObhDg9PWCT0wL2uFgY csWXa4aTXi+tszlOE6kFpN47Loiy6PFQtfGSBJt6uXpy18tA1zvj4IYILHh8o42NrQX5 B29ccrIgDSWmB6jQNuzoJFMEun8EWqoO1+P2BmPIHl8nwJSm+49dPgJz6Xj0BZAB2hJV 5uFw== X-Gm-Message-State: AOUpUlHCC/HX6pluhE4FdxBwcNSa5JvAlwAIF4VNXJmwQipbzNVXihqS qBchj2BA7GsP2dXLN6kja8M+wqDh X-Google-Smtp-Source: AAOMgpeI4xa8R5CsbsBAjb7zkT1OoOQJY9T0M7AilGOvMDoHUBbaq6FMBNQndzRUz2n2jIeiAsA6xQ== X-Received: by 2002:a63:4d06:: with SMTP id a6-v6mr20276520pgb.408.1533044078655; Tue, 31 Jul 2018 06:34:38 -0700 (PDT) Received: from arushi-HP-Laptop-15-bs1xx ([2405:204:641d:5f99:f9a2:c07:9e27:db9f]) by smtp.gmail.com with ESMTPSA id p73-v6sm12442960pfk.186.2018.07.31.06.34.36 (version=TLS1 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 31 Jul 2018 06:34:38 -0700 (PDT) Date: Tue, 31 Jul 2018 19:04:33 +0530 From: Arushi Singhal To: pablo@netfilter.org Cc: netfilter-devel@vger.kernel.org Subject: [PATCH] nft: doc: correct some typos in asciidoc Message-ID: <20180731133433.GA21620@arushi-HP-Laptop-15-bs1xx> MIME-Version: 1.0 Content-Disposition: inline User-Agent: Mutt/1.5.24 (2015-08-30) Sender: netfilter-devel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netfilter-devel@vger.kernel.org Correct some typo mistakes done while converting man page source to asciidoc. Signed-off-by: Arushi Singhal --- doc/data-types.txt | 33 ++++++++++----------------------- doc/nft.txt | 11 ++++------- doc/payload-expression.txt | 9 +++++++-- doc/primary-expression.txt | 4 ++-- doc/stateful-objects.txt | 2 +- doc/statements.txt | 4 ++-- 6 files changed, 26 insertions(+), 37 deletions(-) diff --git a/doc/data-types.txt b/doc/data-types.txt index 1d4218e..89ed0d9 100644 --- a/doc/data-types.txt +++ b/doc/data-types.txt @@ -122,30 +122,17 @@ integer The boolean type is a syntactical helper type in user space. It's use is in the right-hand side of a (typically implicit) relational expression to change the expression on the left-hand side into a boolean check (usually for existence). + -The following keywords will automatically resolve into a boolean type with given value: -The bitmask type (bitmask) is used for bitmasks. - +.The following keywords will automatically resolve into a boolean type with given value [options="header"] |================== |Keyword | Value -|exits | +|exists | 1 | missing | 0 |=================== -[options="header"] -|====================================== -|Expression | Behaviour -|fib | -Check route existence. -|exthdr| -Check IPv6 extension header existence. -|tcp option | -Check TCP option header existence. -|=================== - -.expressions support a boolean comparison: +.expressions support a boolean comparison [options="header"] |====================================== |Expression | Behaviour @@ -228,15 +215,15 @@ ICMP CODE TYPE [options="header"] |================== |Name | Keyword | Size | Base type -|ICMP Type | -icmp_type | +|ICMP Code | +icmp_code | 8 bit | integer |=================== The ICMP Code type is used to conveniently specify the ICMP header's code field. -.Keywords may be used when specifying the ICMP type +.Keywords may be used when specifying the ICMP code [options="header"] |================== |Keyword | Value @@ -325,7 +312,7 @@ ICMPV6 CODE TYPE |================== |Name | Keyword | Size | Base type |ICMPv6 Code | -icmpv6_type | +icmpv6_code | 8 bit | integer |=================== @@ -356,7 +343,7 @@ ICMPVX CODE TYPE |================== |Name | Keyword | Size | Base type |ICMPvX Code | -icmpv6_type | +icmpv6_code | 8 bit | integer |=================== @@ -397,7 +384,7 @@ ct_status| 4 byte| bitmask |conntrack event bits| -ct_events | +ct_event | 4 byte | bitmask |conntrack label| @@ -441,7 +428,7 @@ For each of the types above, keywords are available for convenience: |expected| 1 |seen-reply| -1 +2 |assured| 4 |confirmed| diff --git a/doc/nft.txt b/doc/nft.txt index e317cfd..7505aa0 100644 --- a/doc/nft.txt +++ b/doc/nft.txt @@ -186,7 +186,7 @@ RULESET ------- [verse] {list | flush} *ruleset* ['family'] -\{export\} [*ruleset*] {'format'} +export [*ruleset*] 'format' The *ruleset* keyword is used to identify the whole set of tables, chains, etc. currently in place in kernel. The following *ruleset* commands exist: @@ -304,13 +304,10 @@ Rules are added to chain in the given table. If the family is not specified, the The add and insert commands support an optional location specifier, which is either a 'handle' of an existing rule or an 'index' (starting at zero). Internally, rule locations are always identified by 'handle' and the translation from 'index' happens in userspace. This has two potential implications in case a concurrent ruleset change happens after the translation was done: The effective rule index might change if a rule was inserted or deleted before the referred one. If the referred rule was deleted, the command is rejected by the kernel just as if an invalid 'handle' was given. -*add*:: -Add a new rule described by the list of statements. The rule is appended to the given chain unless a position is specified, in which case the rule is appended to the rule given by the 'handle'. The alternative name position is deprecated and should not be used anymore. - -*insert*:: Similar to the *add* command, but the rule is prepended to the beginning of the chain or before the rule at the given position. - +[horizontal] +*add*:: Add a new rule described by the list of statements. The rule is appended to the given chain unless a position is specified, in which case the rule is appended to the rule given by the 'handle'. The alternative name position is deprecated and should not be used anymore. +*insert*:: Similar to the *add* command, but the rule is prepended to the beginning of the chain or before the rule with the given 'handle'. *replace*:: Similar to the add command, but the rule replaces the specified rule. - *delete*:: Delete the specified rule. .*add a rule to ip table input chain* diff --git a/doc/payload-expression.txt b/doc/payload-expression.txt index d454c95..9f8471a 100644 --- a/doc/payload-expression.txt +++ b/doc/payload-expression.txt @@ -41,6 +41,11 @@ EtherType| ether_type |================== +ARP HEADER EXPRESSION +~~~~~~~~~~~~~~~~~~~~~ +[verse] +*arp* ['ARP' 'header' 'field'] + .ARP HEADER EXPRESSION [options="header"] |================== @@ -412,7 +417,7 @@ RAW PAYLOAD EXPRESSION The raw payload expression instructs to load lengthbits starting at offsetbits. Bit 0 refers to the very first bit -- in the C programming language, this corresponds to the topmost bit, i.e. 0x80 in case of an octet. They are useful to match headers that do not have a human-readable template expression yet. Note that nft will not add dependencies for Raw payload expressions. If you e.g. want to match protocol fields of a transport header with protocol number 5, you need to manually exclude packets that have a different transport header, for instance my using meta l4proto 5 before the raw expression. -.Support payload protocol bases +.Supported payload protocol bases [options="header"] |================== |Base| Description @@ -585,6 +590,6 @@ average bytes per packet, see description for packets keyword | integer (64 bit) |zone| conntrack zone | -integer (64 bit) +integer (16 bit) |========================================== A description of conntrack-specific types listed above can be found sub-section CONNTRACK TYPES above. diff --git a/doc/primary-expression.txt b/doc/primary-expression.txt index 162f32f..d0ed6ae 100644 --- a/doc/primary-expression.txt +++ b/doc/primary-expression.txt @@ -22,7 +22,7 @@ real hook protocol family, useful only in inet table| integer (32 bit) |l4proto| layer 4 protocol, skips ipv6 extension headers| -integer (32 bit) +integer (8 bit) |protocol| EtherType protocol value| ether_type @@ -40,7 +40,7 @@ Input interface name | ifname |iiftype| Input interface type| -iface_itype +iface_type |oif| Output interface index| iface_index diff --git a/doc/stateful-objects.txt b/doc/stateful-objects.txt index 9d99264..cf18023 100644 --- a/doc/stateful-objects.txt +++ b/doc/stateful-objects.txt @@ -14,7 +14,7 @@ name of helper type | quoted string (e.g. "ftp") |protocol | layer 4 protocol of the helper | -address family (e.g. ip) +string (e.g. ip) |l3proto | layer 3 protocol of the helper | address family (e.g. ip) diff --git a/doc/statements.txt b/doc/statements.txt index 499b573..b91dd0c 100644 --- a/doc/statements.txt +++ b/doc/statements.txt @@ -80,7 +80,7 @@ Number of packets to queue inside the kernel before sending them to userpace | unsigned integer (32 bit) |================================== -.log statement options +.log-flags [options="header"] |================== | Flag | Description @@ -235,7 +235,7 @@ A limit statement matches at a limited rate using a token bucket filter. A rule .limit statement values [options="header"] |================== -|Value | Description | Type| +|Value | Description | Type |packet_number | Number of packets | unsigned integer (32 bit)