* [PATCH] doc: nft: Fixed a typo and added/changed punctuation
@ 2016-03-07 14:54 Piyush Pangtey
2016-03-07 18:06 ` Pablo Neira Ayuso
0 siblings, 1 reply; 4+ messages in thread
From: Piyush Pangtey @ 2016-03-07 14:54 UTC (permalink / raw)
To: netfilter-devel
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
@@ -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>
--
1.9.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] doc: nft: Fixed a typo and added/changed punctuation
2016-03-07 14:54 [PATCH] doc: nft: Fixed a typo and added/changed punctuation Piyush Pangtey
@ 2016-03-07 18:06 ` Pablo Neira Ayuso
2016-03-08 14:27 ` [PATCH v2] " FaTe
0 siblings, 1 reply; 4+ messages in thread
From: Pablo Neira Ayuso @ 2016-03-07 18:06 UTC (permalink / raw)
To: Piyush Pangtey; +Cc: netfilter-devel
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?
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH v2] doc: nft: Fixed a typo and added/changed punctuation
2016-03-07 18:06 ` Pablo Neira Ayuso
@ 2016-03-08 14:27 ` FaTe
2016-03-09 12:19 ` Pablo Neira Ayuso
0 siblings, 1 reply; 4+ messages in thread
From: FaTe @ 2016-03-08 14:27 UTC (permalink / raw)
To: Pablo Neira Ayuso; +Cc: netfilter-devel
In nft's man page , instead of using '/' between shortopt and longopt in the
"SYNOPSIS" and "OPTIONS" section , use '|' and ',' respectively.
(just like the man pages of iptables, etc.)
Fixed a typo and added missing ',' .
Signed-off-by: Piyush Pangtey <gokuvsvegita@gmail.com>
---
doc/nft.xml | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/doc/nft.xml b/doc/nft.xml
index 7cc9988..e4d227c 100644
--- a/doc/nft.xml
+++ b/doc/nft.xml
@@ -34,19 +34,19 @@ vi:ts=4 sw=4
<cmdsynopsis>
<command>nft</command>
<arg choice="opt">
- <option>-n/--numeric</option>
+ <option>-n | --numeric</option>
</arg>
<arg choice="opt">
- <option>-I/--includepath</option>
+ <option>[-I | --includepath]</option>
<replaceable>directory</replaceable>
</arg>
<group>
<arg choice="opt">
- <option>-f/--file</option>
+ <option>[-f | --file]</option>
<replaceable>filename</replaceable>
</arg>
<arg choice="opt">
- <option>-i/--interactive</option>
+ <option>[-i | --interactive]</option>
</arg>
<arg choice="opt" rep="repeat">
<replaceable>cmd</replaceable>
@@ -56,10 +56,10 @@ vi:ts=4 sw=4
<cmdsynopsis>
<command>nft</command>
<arg choice="opt">
- <option>-h/--help</option>
+ <option>-h | --help</option>
</arg>
<arg choice="opt">
- <option>-v/--version</option>
+ <option>-v | --version</option>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -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>
--
1.9.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH v2] doc: nft: Fixed a typo and added/changed punctuation
2016-03-08 14:27 ` [PATCH v2] " FaTe
@ 2016-03-09 12:19 ` Pablo Neira Ayuso
0 siblings, 0 replies; 4+ messages in thread
From: Pablo Neira Ayuso @ 2016-03-09 12:19 UTC (permalink / raw)
To: FaTe; +Cc: netfilter-devel
On Tue, Mar 08, 2016 at 07:57:15PM +0530, FaTe wrote:
> In nft's man page , instead of using '/' between shortopt and longopt in the
> "SYNOPSIS" and "OPTIONS" section , use '|' and ',' respectively.
> (just like the man pages of iptables, etc.)
>
> Fixed a typo and added missing ',' .
Applied, thanks.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2016-03-09 12:19 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-03-07 14:54 [PATCH] doc: nft: Fixed a typo and added/changed punctuation Piyush Pangtey
2016-03-07 18:06 ` Pablo Neira Ayuso
2016-03-08 14:27 ` [PATCH v2] " FaTe
2016-03-09 12:19 ` Pablo Neira Ayuso
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).