diff mbox

doc: nft: Fixed a typo and added/changed punctuation

Message ID 20160307145420.GA4852@fate
State Changes Requested
Delegated to: Pablo Neira
Headers show

Commit Message

Piyush Pangtey March 7, 2016, 2:54 p.m. UTC
Instead of using '/' longopts , use ',' ,as followed by man pages of other
programs.

Signed-off-by: Piyush Pangtey <gokuvsvegita@gmail.com>
---
 doc/nft.xml | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

Comments

Pablo Neira Ayuso March 7, 2016, 6:06 p.m. UTC | #1
On Mon, Mar 07, 2016 at 08:24:20PM +0530, Piyush Pangtey wrote:
> Instead of using '/' longopts , use ',' ,as followed by man pages of other
> programs.
> 
> Signed-off-by: Piyush Pangtey <gokuvsvegita@gmail.com>
> ---
>  doc/nft.xml | 20 ++++++++++----------
>  1 file changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/doc/nft.xml b/doc/nft.xml
> index 7cc9988..eab97f5 100644
> --- a/doc/nft.xml
> +++ b/doc/nft.xml
> @@ -156,8 +156,8 @@ vi:ts=4 sw=4
>  		<refsect2>
>  			<title>Lexical conventions</title>
>  			<para>
> -				Input is parsed line-wise. When the last character of a line just before
> -				the newline character is a non-quoted backslash (<literal>\</literal>),
> +				Input is parsed line-wise. When the last character of a line, just before
> +				the newline character, is a non-quoted backslash (<literal>\</literal>),
>  				the next line is treated as a continuation. Multiple commands on the
>  				same line can be separated using a semicolon (<literal>;</literal>).
>  			</para>

This looks good, but this chunk doesn't match the description, right?
--
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

Patch

diff --git a/doc/nft.xml b/doc/nft.xml
index 7cc9988..eab97f5 100644
--- a/doc/nft.xml
+++ b/doc/nft.xml
@@ -80,7 +80,7 @@  vi:ts=4 sw=4
 
 		<variablelist>
 			<varlistentry>
-				<term><option>-h/--help</option></term>
+				<term><option>-h, --help</option></term>
 				<listitem>
 					<para>
 						Show help message and all options.
@@ -88,7 +88,7 @@  vi:ts=4 sw=4
 				</listitem>
 			</varlistentry>
 			<varlistentry>
-				<term><option>-v/--version</option></term>
+				<term><option>-v, --version</option></term>
 				<listitem>
 					<para>
 						Show version.
@@ -96,7 +96,7 @@  vi:ts=4 sw=4
 				</listitem>
 			</varlistentry>
 			<varlistentry>
-				<term><option>-n/--numeric</option></term>
+				<term><option>-n, --numeric</option></term>
 				<listitem>
 					<para>
 						Numeric output: Addresses and other information
@@ -117,7 +117,7 @@  vi:ts=4 sw=4
 				</listitem>
 			</varlistentry>
 			<varlistentry>
-				<term><option>-a/--handle</option></term>
+				<term><option>-a, --handle</option></term>
 				<listitem>
 					<para>
 						Show rule handles in output.
@@ -125,15 +125,15 @@  vi:ts=4 sw=4
 				</listitem>
 			</varlistentry>
 			<varlistentry>
-				<term><option>-I/--includepath <replaceable>directory</replaceable></option></term>
+				<term><option>-I, --includepath <replaceable>directory</replaceable></option></term>
 				<listitem>
 					<para>
-						Add the directory <replaceable>directory</replaceable> to the list of directories to by searched for included files.
+						Add the directory <replaceable>directory</replaceable> to the list of directories to be searched for included files.
 					</para>
 				</listitem>
 			</varlistentry>
 			<varlistentry>
-				<term><option>-f/--file <replaceable>filename</replaceable></option></term>
+				<term><option>-f, --file <replaceable>filename</replaceable></option></term>
 				<listitem>
 					<para>
 						Read input from <replaceable>filename</replaceable>.
@@ -141,7 +141,7 @@  vi:ts=4 sw=4
 				</listitem>
 			</varlistentry>
 			<varlistentry>
-				<term><option>-i/--interactive</option></term>
+				<term><option>-i, --interactive</option></term>
 				<listitem>
 					<para>
 						Read input from an interactive readline CLI.
@@ -156,8 +156,8 @@  vi:ts=4 sw=4
 		<refsect2>
 			<title>Lexical conventions</title>
 			<para>
-				Input is parsed line-wise. When the last character of a line just before
-				the newline character is a non-quoted backslash (<literal>\</literal>),
+				Input is parsed line-wise. When the last character of a line, just before
+				the newline character, is a non-quoted backslash (<literal>\</literal>),
 				the next line is treated as a continuation. Multiple commands on the
 				same line can be separated using a semicolon (<literal>;</literal>).
 			</para>