Re: [PATCH] nft: doc: Fixed all the typos in asciidoc

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, Aug 08, 2018 at 11:00:36AM +0530, Arushi Singhal wrote:
> Correct all the typo mistakes done while converting man page source to
> asciidoc.

Hi,

I made only two comments. See below.

> 
> Signed-off-by: Arushi Singhal <arushisinghal19971997@xxxxxxxxx>
> ---
>  doc/data-types.txt         | 2 +-
>  doc/nft.txt                | 7 +++----
>  doc/primary-expression.txt | 2 +-
>  doc/statements.txt         | 6 +++---
>  4 files changed, 8 insertions(+), 9 deletions(-)
>  mode change 100644 => 100755 doc/nft.txt
> 
> diff --git a/doc/data-types.txt b/doc/data-types.txt
> index 8bbdd57..39c65ac 100644
> --- a/doc/data-types.txt
> +++ b/doc/data-types.txt
> @@ -362,7 +362,7 @@ ICMPVX CODE TYPE
>  |==================
>  |Name | Keyword | Size | Base type
>  |ICMPvX Code |
> -icmpv6_type |
> +icmpx_code |

icmpvx ?

>  8 bit |
>  integer
>  |===================
> diff --git a/doc/nft.txt b/doc/nft.txt
> old mode 100644
> new mode 100755
> index 0f824a5..c1e807c
> --- a/doc/nft.txt
> +++ b/doc/nft.txt
> @@ -61,8 +61,8 @@ For a full summary of options, run *nft --help*.
>  
>  *-e*::
>  *--echo*::
> -	When  inserting  items  into the ruleset using add, insert or replace commands, print notifications
> -	just like nft monitor.
> +	When  inserting  items  into the ruleset using *add*, *insert* or *replace* commands, print notifications
> +	just like *nft monitor*.
>  
>  *-I*::
>  *--includepath directory*::
> @@ -72,7 +72,7 @@ For a full summary of options, run *nft --help*.
>  *-f*::
>  *--file 'filename'*::
>  	Read input from 'filename'. If 'filename' is -, read from stdin. +
> -	nft scripts must start #!/usr/sbin/nft -f
> +	nft scripts must start *#!/usr/sbin/nft -f*
>  
>  *-i*::
>  *--interactive*::
> @@ -571,7 +571,6 @@ numbers etc. or data gathered from the packet  during  ruleset  evaluation.
>  Expressions can be combined using binary, logical, relational and other types of
>  expressions to form complex or relational (match) expressions. They are also
>  used as arguments to certain types of operations, like NAT, packet marking etc.
> -+
>  
>  Each expression has a data type, which determines the size, parsing and
>  representation of symbolic values and type compatibility with other expressions.
> diff --git a/doc/primary-expression.txt b/doc/primary-expression.txt
> index 13adfe3..3cea23e 100644
> --- a/doc/primary-expression.txt
> +++ b/doc/primary-expression.txt
> @@ -130,7 +130,7 @@ raw prerouting meta secpath exists accept
>  SOCKET EXPRESSION
>  ~~~~~~~~~~~~~~~~~
>  [verse]
> -socket {transparent}
> +socket \{transparent\}
>  
>  Socket expression can be used to search for an existing open TCP/UDP socket and
>  its attributes that can be associated with a packet. It looks for an established
> diff --git a/doc/statements.txt b/doc/statements.txt
> index 8a54a6b..19ed197 100644
> --- a/doc/statements.txt
> +++ b/doc/statements.txt
> @@ -62,8 +62,8 @@ tcp flags syn tcp option maxseg size set rt mtu
>  LOG STATEMENT
>  ~~~~~~~~~~~~~
>  [verse]
> -log [prefix quoted_string] [level syslog-level] [flags log-flags]
> -log group nflog_group [prefix quoted_string] [queue-threshold value] [snaplen size]
> +*log* [prefix 'quoted_string'] [level 'syslog-level'] [flags 'log-flags']
> +*log* group 'nflog_group' [prefix 'quoted_string'] [queue-threshold 'value'] [snaplen 'size']
>  
>  The log statement enables logging of matching packets. When this statement is
>  used from a rule, the Linux kernel will print some information on all matching
> @@ -165,7 +165,7 @@ COUNTER STATEMENT
>  A counter statement sets the hit count of packets along with the number of bytes.
>  
>  [verse]
> -counter [ packets 'number' bytes 'number' ]
> +*counter* [ packets 'number' bytes 'number' ]

How do you decide if the keyword should be bold or not? I'm asking this because
even in this comment there is a syntax line where the keyword is not bold, and
if you are doing this, perhaps it's better do it everywhere or nowhere to avoid
later commits with the same purpose. There has already been some fixing typos.

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



[Index of Archives]     [Netfitler Users]     [LARTC]     [Bugtraq]     [Yosemite Forum]

  Powered by Linux