Re: [netmod] tree diagrams - flags

[Ladislav Lhotka <[e-mail]>]

> On 21 Mar 2017, at 15:11, Juergen Schoenwaelder <[e-mail]> wrote:
> 
> On Tue, Mar 21, 2017 at 01:01:58PM +0100, Ladislav Lhotka wrote:
>> 
>>> On 21 Mar 2017, at 12:50, Robert Wilton <[e-mail]> wrote:
>>> 
>>> 
>>> So I am suggesting perhaps just having:
>>> 
>>> <flags> is one of:
>>>  c  for configuration data
>>>  x  for rpcs and actions
>>>  n  for notifications
>>> 
>>> module: tree-sample
>>>  +--c config-true-container
>>>  |  +--c param?   string
>>>  +--- config-false-container
>>>  |  +-- value?   string
>>>  +--c inline-action
>>>  |  +--x- action
>>>  |     +--x input
>>>  |     |  +--x in?   string
>>>  |     +--x output
>>>  |        +--x out?   string
>>>  +--c inline-notification
>>>     +--n notification
>>>        +--n duration?   string
>> 
>> I think the "x" and "n" is only needed next to the name of rpc/action/notification. So my version would be:
>> 
>> <flags> is one of:
>>  c  for configuration data
>>  x  for rpcs and actions
>>  n  for notifications
>> 
>> module: tree-sample
>>  +--c config-true-container
>>  |  +--c param?   string
>>  +--- config-false-container
>>  |  +--- value?   string
>>  +--c inline-action
>>  |  +--x action
>>  |     +--- input
>>  |     |  +--- in?   string
>>  |     +--- output
>>  |        +--- out?   string
>>  +--c inline-notification
>>     +--n notification
>>        +--- duration?   string
>> 
> 
> Single character flags work for me as well. Since I have modules with
> pretty complex RPC inputs (more than a single page in RFC formatting),
> I think it is useful to be able to see that one is still starting at
> an RPC input tree and not a regular data tree or a notification tree.

Even with long RPC parameter lists the indentation should make it obvious what belongs where. Another option might be to label every input parameter with "xi" or "i" and output with "xo"/"o", and remove the "input" and "output" nodes. This would make the output shorter and narrower.

> So I tend to like Rob's proposal a bit more.

Note however that Rob's proposal doesn't distinguish input and output parameters, all are labelled with "x".

Lada

> 
> /js
> 
> -- 
> Juergen Schoenwaelder           Jacobs University Bremen gGmbH
> Phone: [phone]         Campus Ring 1 | 28759 Bremen | Germany
> Fax:   [phone]         <http://www.jacobs-university.de/>

--
Ladislav Lhotka, CZ.NIC Labs
PGP Key ID: 0xB8F92B08A9F76C67