{"id":802676,"url":"http://patchwork.ozlabs.org/api/1.2/patches/802676/?format=json","web_url":"http://patchwork.ozlabs.org/project/netfilter-devel/patch/20170817133900.21946-2-phil@nwl.cc/","project":{"id":26,"url":"http://patchwork.ozlabs.org/api/1.2/projects/26/?format=json","name":"Netfilter Development","link_name":"netfilter-devel","list_id":"netfilter-devel.vger.kernel.org","list_email":"netfilter-devel@vger.kernel.org","web_url":null,"scm_url":null,"webscm_url":null,"list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<20170817133900.21946-2-phil@nwl.cc>","list_archive_url":null,"date":"2017-08-17T13:38:59","name":"[nft,1/2] nft.8: Fix and enhance synopsis section","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"528eb0420492d190a9da6191fa9163615d2570fa","submitter":{"id":4285,"url":"http://patchwork.ozlabs.org/api/1.2/people/4285/?format=json","name":"Phil Sutter","email":"phil@nwl.cc"},"delegate":{"id":6139,"url":"http://patchwork.ozlabs.org/api/1.2/users/6139/?format=json","username":"pablo","first_name":"Pablo","last_name":"Neira","email":"pablo@netfilter.org"},"mbox":"http://patchwork.ozlabs.org/project/netfilter-devel/patch/20170817133900.21946-2-phil@nwl.cc/mbox/","series":[],"comments":"http://patchwork.ozlabs.org/api/patches/802676/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/802676/checks/","tags":{},"related":[],"headers":{"Return-Path":"<netfilter-devel-owner@vger.kernel.org>","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@bilbo.ozlabs.org","Authentication-Results":"ozlabs.org;\n\tspf=none (mailfrom) smtp.mailfrom=vger.kernel.org\n\t(client-ip=209.132.180.67; helo=vger.kernel.org;\n\tenvelope-from=netfilter-devel-owner@vger.kernel.org;\n\treceiver=<UNKNOWN>)","Received":["from vger.kernel.org (vger.kernel.org [209.132.180.67])\n\tby ozlabs.org (Postfix) with ESMTP id 3xY6kw05lSz9t4X\n\tfor <incoming@patchwork.ozlabs.org>;\n\tThu, 17 Aug 2017 23:39:20 +1000 (AEST)","(majordomo@vger.kernel.org) by vger.kernel.org via listexpand\n\tid S1752031AbdHQNjT (ORCPT <rfc822;incoming@patchwork.ozlabs.org>);\n\tThu, 17 Aug 2017 09:39:19 -0400","from orbyte.nwl.cc ([151.80.46.58]:39055 \"EHLO mail.nwl.cc\"\n\trhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP\n\tid S1751637AbdHQNjT (ORCPT <rfc822; netfilter-devel@vger.kernel.org>);\n\tThu, 17 Aug 2017 09:39:19 -0400","from mail.nwl.cc (orbyte.nwl.cc [127.0.0.1])\n\tby mail.nwl.cc (Postfix) with ESMTP id 46CEF63864;\n\tThu, 17 Aug 2017 15:39:18 +0200 (CEST)","from xsao (localhost [IPv6:::1])\n\tby mail.nwl.cc (Postfix) with ESMTP id 29CDD63860;\n\tThu, 17 Aug 2017 15:39:18 +0200 (CEST)"],"From":"Phil Sutter <phil@nwl.cc>","To":"Pablo Neira Ayuso <pablo@netfilter.org>","Cc":"netfilter-devel@vger.kernel.org","Subject":"[nft PATCH 1/2] nft.8: Fix and enhance synopsis section","Date":"Thu, 17 Aug 2017 15:38:59 +0200","Message-Id":"<20170817133900.21946-2-phil@nwl.cc>","X-Mailer":"git-send-email 2.13.1","In-Reply-To":"<20170817133900.21946-1-phil@nwl.cc>","References":"<20170817133900.21946-1-phil@nwl.cc>","X-Virus-Scanned":"ClamAV using ClamSMTP","Sender":"netfilter-devel-owner@vger.kernel.org","Precedence":"bulk","List-ID":"<netfilter-devel.vger.kernel.org>","X-Mailing-List":"netfilter-devel@vger.kernel.org"},"content":"This patch addresses shortcomings in the main synopsis section\nillustrating possible invocations of nft command:\n\n- Fix font styles to correctly put options into bold font and meta\n  characters (brackets, pipes) into normal font.\n\n- Add missing options to synopsis line.\n\n- Use curly braces where either one of the alternatives is required.\n\n- Remove choice=\"opt\" attribute since that is the default anyway.\n\n- Note that --includepath option is allowed to be given multiple times.\n\nSigned-off-by: Phil Sutter <phil@nwl.cc>\n---\n doc/nft.xml | 74 +++++++++++++++++++++++++++++++++++++++++--------------------\n 1 file changed, 50 insertions(+), 24 deletions(-)","diff":"diff --git a/doc/nft.xml b/doc/nft.xml\nindex d7aae3f03b8c1..191a4c12f8487 100644\n--- a/doc/nft.xml\n+++ b/doc/nft.xml\n@@ -45,40 +45,66 @@ vi:ts=4 sw=4\n \t<refsynopsisdiv>\n \t\t<cmdsynopsis>\n \t\t\t<command>nft</command>\n-\t\t\t<arg choice=\"opt\">\n-\t\t\t\t<option>-n | --numeric</option>\n-\t\t\t</arg>\n-\t\t\t<arg choice=\"opt\">\n-\t\t\t\t<option>-s | --stateless</option>\n-\t\t\t</arg>\n-\t\t\t<arg choice=\"opt\">\n-\t\t\t\t<option>-c | --check</option>\n-\t\t\t</arg>\n-\t\t\t<arg choice=\"opt\">\n-\t\t\t\t<option>[-I | --includepath]</option>\n+\t\t\t<group>\n+\t\t\t\t<arg><option>-n</option></arg>\n+\t\t\t\t<arg><option>--numeric</option></arg>\n+\t\t\t</group>\n+\t\t\t<group>\n+\t\t\t\t<arg><option>-N</option></arg>\n+\t\t\t\t<arg><option>--reversedns</option></arg>\n+\t\t\t</group>\n+\t\t\t<group>\n+\t\t\t\t<arg><option>-s</option></arg>\n+\t\t\t\t<arg><option>--stateless</option></arg>\n+\t\t\t</group>\n+\t\t\t<group>\n+\t\t\t\t<arg><option>-c</option></arg>\n+\t\t\t\t<arg><option>--check</option></arg>\n+\t\t\t</group>\n+\t\t\t<group>\n+\t\t\t\t<arg><option>-a</option></arg>\n+\t\t\t\t<arg><option>--handle</option></arg>\n+\t\t\t</group>\n+\t\t\t<group>\n+\t\t\t\t<arg><option>-e</option></arg>\n+\t\t\t\t<arg><option>--echo</option></arg>\n+\t\t\t</group>\n+\t\t\t<arg>\n+\t\t\t\t<group choice=\"req\">\n+\t\t\t\t\t<arg><option>-I</option></arg>\n+\t\t\t\t\t<arg><option>--includepath</option></arg>\n+\t\t\t\t</group>\n \t\t\t\t<replaceable>directory</replaceable>\n \t\t\t</arg>\n \t\t\t<group>\n-\t\t\t\t<arg choice=\"opt\">\n-\t\t\t\t\t<option>[-f | --file]</option>\n+\t\t\t\t<arg>\n+\t\t\t\t\t<group choice=\"req\">\n+\t\t\t\t\t\t<arg><option>-f</option></arg>\n+\t\t\t\t\t\t<arg><option>--file</option></arg>\n+\t\t\t\t\t</group>\n \t\t\t\t\t<replaceable>filename</replaceable>\n \t\t\t\t</arg>\n-\t\t\t\t<arg choice=\"opt\">\n-\t\t\t\t\t<option>[-i | --interactive]</option>\n+\t\t\t\t<arg>\n+\t\t\t\t\t<group choice=\"req\">\n+\t\t\t\t\t\t<arg><option>-i</option></arg>\n+\t\t\t\t\t\t<arg><option>--interactive</option></arg>\n+\t\t\t\t\t</group>\n \t\t\t\t</arg>\n-\t\t\t\t<arg choice=\"opt\" rep=\"repeat\">\n+\t\t\t\t<arg rep=\"repeat\">\n \t\t\t\t\t<replaceable>cmd</replaceable>\n \t\t\t\t</arg>\n \t\t\t</group>\n \t\t</cmdsynopsis>\n \t\t<cmdsynopsis>\n \t\t\t<command>nft</command>\n-\t\t\t<arg choice=\"opt\">\n-\t\t\t\t<option>-h | --help</option>\n-\t\t\t</arg>\n-\t\t\t<arg choice=\"opt\">\n-\t\t\t\t<option>-v | --version</option>\n-\t\t\t</arg>\n+\t\t\t<group>\n+\t\t\t\t<arg><option>-h</option></arg>\n+\t\t\t\t<arg><option>--help</option></arg>\n+\t\t\t</group>\n+\t\t\t<group>\n+\t\t\t\t<arg><option>-v</option></arg>\n+\t\t\t\t<arg><option>--version</option></arg>\n+\t\t\t</group>\n \t\t</cmdsynopsis>\n \t</refsynopsisdiv>\n \n@@ -141,7 +167,7 @@ vi:ts=4 sw=4\n \t\t\t\t</listitem>\n \t\t\t</varlistentry>\n \t\t\t<varlistentry>\n-\t\t\t\t<term><option>-N</option></term>\n+\t\t\t\t<term><option>-N, --reversedns</option></term>\n \t\t\t\t<listitem>\n \t\t\t\t\t<para>\n \t\t\t\t\t\tTranslate IP addresses to names. Usually requires network traffic for DNS lookup.\n@@ -170,7 +196,7 @@ vi:ts=4 sw=4\n \t\t\t\t<term><option>-I, --includepath <replaceable>directory</replaceable></option></term>\n \t\t\t\t<listitem>\n \t\t\t\t\t<para>\n-\t\t\t\t\t\tAdd the directory <replaceable>directory</replaceable> to the list of directories to be searched for included files.\n+\t\t\t\t\t\tAdd the directory <replaceable>directory</replaceable> to the list of directories to be searched for included files. This option may be specified multiple times.\n \t\t\t\t\t</para>\n \t\t\t\t</listitem>\n \t\t\t</varlistentry>\n","prefixes":["nft","1/2"]}