On 6 September 2017 at 10:41, Phil Sutter <phil@xxxxxx> wrote: > Beware: The conversion is incomplete and merely serves as base for > discussion. > > This patch converts nft.xml into asciidoc markup, top down until (and > including) stateful objects description. I stopped there because it's > the first chance of demonstrating my idea of splitting the documentation > into smaller pieces for convenience and maintainability. > > Regarding package dependencies, this "just" exchanges docbook with > asciidoc - dblatex is still required for PDF creation. > Hi Phil, thanks for your initiative and hard work, it's really appreciated :-) Regarding the change, why asciidoc? why not markdown, or org-mode or reStructuredText? There are many markup languages, it reminds me to xkcd #927 [0]. I would prefer if we stick to groff, which seems to be the standard in Linux. Regarding the separation of text in different includes, why not creating different manpages? Netfilter did this in the past with iptables(8) and iptables-extensions(8). Brainstorming: * nft(8) <-- main document, general info * nft-ct(8) <-- concrete info for ct objects * nft-counter(8) <-- concrete info for counter objets * nft-flowtables(8) <-- about flow tables * nft-quota(8) <--- concrete info for quotas * nft-performance(8) <--- concrete info about nftables sets, maps, dicts, concatenations, etc. * nft-ha(8) <--- for HA environments, loadbalancing etc [0] https://xkcd.com/927/ -- To unsubscribe from this list: send the line "unsubscribe netfilter-devel" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
