Re: [iptables PATCH 06/16] man: iptables.8: Trivial font fixes

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Jan,

First of all, thanks a lot for reviewing these "boring" changes. :)

On Wed, Aug 02, 2023 at 10:37:53AM +0200, Jan Engelhardt wrote:
> On Wednesday 2023-08-02 04:03, Phil Sutter wrote:
> 
> >No content changes intended, just type commands in bold and the single
> >path reference in italics.
> >
> >diff --git a/iptables/iptables.8.in b/iptables/iptables.8.in
> >index 71a6251d6b00c..5a9cec6c9eb35 100644
> >--- a/iptables/iptables.8.in
> >+++ b/iptables/iptables.8.in
> >@@ -200,7 +200,7 @@ or
> > .TP
> > \fB\-S\fP, \fB\-\-list\-rules\fP [\fIchain\fP]
> > Print all rules in the selected chain.  If no chain is selected, all
> >-chains are printed like iptables-save. Like every other iptables command,
> >+chains are printed like \fBiptables-save\fP. Like every other iptables command,
> > it applies to the specified table (filter is the default).
> 
> Lacking different markup options, I used bold for things you type verbatim
> (would use <tt></tt> in HTML or `` in MD/RST), and italics for replacables.
> 
> In that instance,
> 	...printed like iptables-save.
> was meant to indeed read like a name, i.e.
> 	...printed like iptables-save(8).
> not like a command, i.e.
> 	...printed like `iptables-save`.

I tried to stick to this paradigm, but it's confusing and I probably
lost track here and there. Even in your example above, "printed like
iptables-save", in mind I extend to "printed like the command
iptables-save does" and therefore choose bold font. I'm obviously not
the best candidate to make these choices.

> (Also note that ifff you did \fBiptables-save\fP, it would have need to be
> \fBiptables\-save\fP, because that is required for verbatim forms.)

Ah, thanks! It's misleading if output looks fine anyway.

> The same argument goes for all the rest:
> 
> >@@ -242,30 +242,30 @@ The following parameters make up a rule specification (as used in the
> > add, delete, insert, replace and append commands).
> > .TP
> > \fB\-4\fP, \fB\-\-ipv4\fP
> >-This option has no effect in iptables and iptables-restore.
> >+This option has no effect in \fBiptables\fP and \fBiptables-restore\fP.
> > If a rule using the \fB\-4\fP option is inserted with (and only with)
> >-ip6tables-restore, it will be silently ignored. Any other uses will throw an
> >+\fBip6tables-restore\fP, it will be silently ignored. Any other uses will throw an

Can you maybe clarify how to distinct between "command" and "name"? I'm
tempted to just leave things as they are instead of doing changes
randomly.

Thanks, Phil



[Index of Archives]     [Netfitler Users]     [Berkeley Packet Filter]     [LARTC]     [Bugtraq]     [Yosemite Forum]

  Powered by Linux