{"id":802677,"url":"http://patchwork.ozlabs.org/api/1.2/patches/802677/?format=json","web_url":"http://patchwork.ozlabs.org/project/netfilter-devel/patch/20170817133900.21946-3-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-3-phil@nwl.cc>","list_archive_url":null,"date":"2017-08-17T13:39:00","name":"[nft,RFC,2/2] nft.8: Make use of synopfragment in synopsis section","commit_ref":null,"pull_url":null,"state":"changes-requested","archived":false,"hash":"acba6d01ea7df934ad7161afd89a82d01a51c258","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-3-phil@nwl.cc/mbox/","series":[],"comments":"http://patchwork.ozlabs.org/api/patches/802677/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/802677/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 3xY6l226bZz9s71\n\tfor <incoming@patchwork.ozlabs.org>;\n\tThu, 17 Aug 2017 23:39:26 +1000 (AEST)","(majordomo@vger.kernel.org) by vger.kernel.org via listexpand\n\tid S1752159AbdHQNj0 (ORCPT <rfc822;incoming@patchwork.ozlabs.org>);\n\tThu, 17 Aug 2017 09:39:26 -0400","from orbyte.nwl.cc ([151.80.46.58]:54679 \"EHLO mail.nwl.cc\"\n\trhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP\n\tid S1751637AbdHQNjZ (ORCPT <rfc822; netfilter-devel@vger.kernel.org>);\n\tThu, 17 Aug 2017 09:39:25 -0400","from mail.nwl.cc (orbyte.nwl.cc [127.0.0.1])\n\tby mail.nwl.cc (Postfix) with ESMTP id 825D163864;\n\tThu, 17 Aug 2017 15:39:24 +0200 (CEST)","from xsao (localhost [IPv6:::1])\n\tby mail.nwl.cc (Postfix) with ESMTP id 6873E63860;\n\tThu, 17 Aug 2017 15:39:24 +0200 (CEST)"],"From":"Phil Sutter <phil@nwl.cc>","To":"Pablo Neira Ayuso <pablo@netfilter.org>","Cc":"netfilter-devel@vger.kernel.org","Subject":"[nft PATCH RFC 2/2] nft.8: Make use of synopfragment in synopsis\n\tsection","Date":"Thu, 17 Aug 2017 15:39:00 +0200","Message-Id":"<20170817133900.21946-3-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 introduces an element of indirection to list common options in\na separate place and allows to put each of the three invocation variants\nonto it's own line.\n\nSigned-off-by: Phil Sutter <phil@nwl.cc>\n---\nWhile I think readability has increased quite a bit, I don't like how\ndocbook formats these references: Having a name at the reference point\nbut not at the target is kind of unintuitive.\n\nAnother issue is that I couldn't get it to print the repeat marker\n('...') inside of the brackets when referencing OPTIONS - it would end\nup past the closing bracket, which appears wrong to my eye. So I used\nthis double indirection as one would without that repeat marker, which\ndidn't really improve it.\n---\n doc/nft.xml | 112 ++++++++++++++++++++++++++++++++++--------------------------\n 1 file changed, 64 insertions(+), 48 deletions(-)","diff":"diff --git a/doc/nft.xml b/doc/nft.xml\nindex 191a4c12f8487..2942849d8b15f 100644\n--- a/doc/nft.xml\n+++ b/doc/nft.xml\n@@ -45,67 +45,83 @@ vi:ts=4 sw=4\n \t<refsynopsisdiv>\n \t\t<cmdsynopsis>\n \t\t\t<command>nft</command>\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<arg>\n+\t\t\t\t<synopfragmentref linkend=\"opts\">OPTIONS</synopfragmentref>\n+\t\t\t</arg>\n+\t\t\t<group choice=\"req\">\n+\t\t\t\t<arg><option>-f</option></arg>\n+\t\t\t\t<arg><option>--file</option></arg>\n \t\t\t</group>\n+\t\t\t<replaceable>filename</replaceable>\n+\t\t</cmdsynopsis>\n+\t\t<cmdsynopsis>\n+\t\t\t<command>nft</command>\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\t<synopfragmentref linkend=\"opts\">OPTIONS</synopfragmentref>\n \t\t\t</arg>\n-\t\t\t<group>\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>\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 rep=\"repeat\">\n-\t\t\t\t\t<replaceable>cmd</replaceable>\n-\t\t\t\t</arg>\n+\t\t\t<group choice=\"req\">\n+\t\t\t\t<arg><option>-i</option></arg>\n+\t\t\t\t<arg><option>--interactive</option></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<group>\n+\t\t\t<arg>\n+\t\t\t\t<synopfragmentref linkend=\"opts\">OPTIONS</synopfragmentref>\n+\t\t\t</arg>\n+\t\t\t<arg choice=\"plain\" rep=\"repeat\">\n+\t\t\t\t<replaceable>cmd</replaceable>\n+\t\t\t</arg>\n+\t\t</cmdsynopsis>\n+\t\t<cmdsynopsis>\n+\t\t\t<command>nft</command>\n+\t\t\t<group choice=\"req\">\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\t<cmdsynopsis>\n+\t\t\t<synopfragment id=\"opts\">\n+\t\t\t\t<arg choice=\"plain\" rep=\"repeat\">\n+\t\t\t\t\t<synopfragmentref linkend=\"opt\">OPTION</synopfragmentref>\n+\t\t\t\t</arg>\n+\t\t\t</synopfragment>\n+\t\t\t<synopfragment id=\"opt\">\n+\t\t\t\t<group>\n+\t\t\t\t\t<arg><option>-n</option></arg>\n+\t\t\t\t\t<arg><option>--numeric</option></arg>\n+\t\t\t\t</group>\n+\t\t\t\t<group>\n+\t\t\t\t\t<arg><option>-N</option></arg>\n+\t\t\t\t\t<arg><option>--reversedns</option></arg>\n+\t\t\t\t</group>\n+\t\t\t\t<group>\n+\t\t\t\t\t<arg><option>-s</option></arg>\n+\t\t\t\t\t<arg><option>--stateless</option></arg>\n+\t\t\t\t</group>\n+\t\t\t\t<group>\n+\t\t\t\t\t<arg><option>-c</option></arg>\n+\t\t\t\t\t<arg><option>--check</option></arg>\n+\t\t\t\t</group>\n+\t\t\t\t<group>\n+\t\t\t\t\t<arg><option>-a</option></arg>\n+\t\t\t\t\t<arg><option>--handle</option></arg>\n+\t\t\t\t</group>\n+\t\t\t\t<group>\n+\t\t\t\t\t<arg><option>-e</option></arg>\n+\t\t\t\t\t<arg><option>--echo</option></arg>\n+\t\t\t\t</group>\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>--includepath</option></arg>\n+\t\t\t\t\t</group>\n+\t\t\t\t\t<replaceable>directory</replaceable>\n+\t\t\t\t</arg>\n+\t\t\t</synopfragment>\n+\t\t</cmdsynopsis>\n \t</refsynopsisdiv>\n \n \t<refsect1>\n","prefixes":["nft","RFC","2/2"]}