Re: [PATCH nft] doc: update nft list plural form parameters

[Fernando Fernandez Mancera <ffmancera@riseup.net>]

Hi,

On 4/4/19 2:01 PM, Pablo Neira Ayuso wrote:
> Cc'ing Duncan, he's been helping with reviewing documentation.
> 
> On Thu, Apr 04, 2019 at 01:41:58PM +0200, Fernando Fernandez Mancera wrote:
>> Signed-off-by: Fernando Fernandez Mancera <ffmancera@riseup.net>
>> ---
>>  doc/nft.txt | 13 +++++++++----
>>  1 file changed, 9 insertions(+), 4 deletions(-)
>>
>> diff --git a/doc/nft.txt b/doc/nft.txt
>> index d162dad..36a92fe 100644
>> --- a/doc/nft.txt
>> +++ b/doc/nft.txt
>> @@ -256,6 +256,7 @@ TABLES
>>  [verse]
>>  {add | create} *table* ['family'] 'table' [ {flags 'flags'} ]
>>  {delete | list | flush} *table* ['family'] 'table'
>> +list *tables*
>>  delete *table* ['family'] handle 'handle'
>>  
>>  Tables are containers for chains, sets and stateful objects. They are identified
>> @@ -266,7 +267,8 @@ nfproto* keyword can be used to test which family (ipv4 or ipv6) context the
>>  packet is being processed in. When no address family is specified, *ip* is used
>>  by default. The only difference between add and create is that the former will
>>  not return an error if the specified table already exists while *create* will
>> -return an error.
>> +return an error. The plural form of list can be used to list all the existing
>> +tables.
> 
> Not sure we need this sentence, I mean, not sure if reader will
> correlate this with 'list tables'.
> 
> Probably just adding:
> 
> list *tables*
> 
> and so on, for other objects in the [verse] area is just enough.
> 

But do you think we need to keep the stateful objects one? If not, how
should we state that a plural form can be used with stateful objects?
Thanks!

>> @@ -609,7 +613,8 @@  delete type ['family'] 'table' handle 'handle'
>>  
>>  Stateful objects are attached to tables and are identified by an unique name.
>>  They group stateful information from rules, to reference them in rules the
>> -keywords "type name" are used e.g. "counter name".
>> +keywords "type name" are used e.g. "counter name". The plural form can be used
>> +to list all exisiting stateful objects e.g "list counters".
>>  
>>  [horizontal]
>>  *add*:: Add a new stateful object in the specified table.
> Thanks!
>