Re: [apps-discuss] AppsDir review of draft-ietf-sipclf-format-05

[Claudio Allocchio <[e-mail]>]

Hello all!

>> * Section "3. Document Conventions"
>>
>> The authors have decided "For the sake of clarity and completeness" to 
>> quote a full section of RFC4475 into this document. However there were 
>> quite long discussions in the Apps Dir in other reviews if this quoting 
>> practice is appropriate or not, because it can lead to discrepacies, 
>> when the quoted document is updated or obsoleted, resuing in confusion 
>> for the readers who just trust the quoted text without checking the 
>> state of the referenced document. I would suggest, as in the other 
>> cases, NOT to quote the external text, but to use an explicit external 
>> reference only, urging the reader to check that "for the sake of 
>> clarity".
>
> I agree with the position but in this particular case I'm of the mind 
> that removing that text and referencing the RFC diminishes the 
> effectiveness of that section. It is my preference to leave the quoted 
> text (which is very short) embedded in this document as it is critical 
> to understanding the notation used throughout the document.

maybe a possible compromise is to quote the text, as is now, but to add a 
small note which reminds the reader to check the update/obsoletes status 
of RFC4475? ;-)

>> * Section "4. Format"
>>
> This is something that we have discussed and have not found an elegant 
> solution for. While there are maintenance risks it was thought to be 
> very valuable to display the pertinent portion of the complete CLF 
> within the section where that was discussed. I'll do my best to ensure 
> that they are all copied over properly from Figure 1.

as I said, it is a Nit... thanks for taking some time in thinking about 
it.

have a nice day!


------------------------------------------------------------------------------
Claudio Allocchio             G   A   R   R          [e-mail]
                         Senior Technical Officer
tel: [phone]      Italian Academic and       G=Claudio; S=Allocchio;
fax: [phone]        Research Network         P=garr; A=garr; C=it;

            PGP Key: http://www.cert.garr.it/PGP/keys.php3#ca