[SLOF] [PATCH slof v5 2/6] node: Add some documentation

[Alexey Kardashevskiy]

On 16/10/17 17:47, Segher Boessenkool wrote:
> Hi!
> 
> On Mon, Oct 16, 2017 at 04:16:49PM +1100, Alexey Kardashevskiy wrote:
>> +\ WARNING: the wid>xxx and name>xxx definitions below are for the documentation
>> +\ purposes only; NAME>LINK LINK> NAME> should be used instead; no code outside
>> +\ of the engine has any business accessing flags, count, chars directly.
>> +
>> +\ STRUCT
>> +\  cell FIELD wid>next
>> +\  cell FIELD wid>names \ the head of the list of name records, points to name>next
>> +\ END-STRUCT
> 
> It points to the first word in the list.  A word starts with the link
> field, but that is just a detail.

I'll make it:

\  cell FIELD wid>names \ points to the first word in the list (grep name>next)

I am adding this mostly for grepping sometime later.


> 
>> diff --git a/slof/fs/node.fs b/slof/fs/node.fs
>> index 3b079e4..add5760 100644
>> --- a/slof/fs/node.fs
>> +++ b/slof/fs/node.fs
>> @@ -23,7 +23,7 @@ STRUCT
>>    cell FIELD node>peer
>>    cell FIELD node>parent
>>    cell FIELD node>child
>> -  cell FIELD node>properties
>> +  cell FIELD node>properties \ points to wid>next
>>    cell FIELD node>words
>>    cell FIELD node>instance-template
>>    cell FIELD node>instance-size
> 
> Similarly, this is just a wid, just like the "words" field.
> 
> 
> Segher
> 


-- 
Alexey