svn commit: r340819 - head/security/vuxml

[Warren Block]

On Fri, 24 Jan 2014, Remko Lodder wrote:
> On 24 Jan 2014, at 08:25, Remko Lodder <remko at FreeBSD.org> wrote:
>> On 23 Jan 2014, at 23:41, Matthias Andree <mandree at FreeBSD.org> wrote:
>>> Am 23.01.2014 22:24, schrieb Remko Lodder:
>>>
>>>> Make validate checks whether the correct tags had been used at the right places.
>>>> Documentation follows the FDP primer, which states how this works. Perhaps
>>>> igor can be used to suggest a better strategy, most of the desired format is
>>>> already included, all you have to do is properly fill it in, or sneakpeak at
>>>> an already written entry.
>>>
>>> It's not the "I can" but that we'd as a whole be more productive if I
>>> could verify the style, or even better have it automatically reformatted
>>> to style (of course your ellipsis removal is another thing that requires
>>> a manual step), and then commit a properly styled entry.
>>>
>>> With a very strong inclination towards "reformat", surely there must be
>>> some tweakable XML formatter in ports that we can beat into shape.

Vuxml seems like a can of worms, and I've never really looked at it 
much.  But given that nobody should be expected to be familiar with a 
particular style or usage of XML, I personally would lean towards 
writing a script that would take the information, then wrap it with the 
right XML markup and format it as desired.  pgj@ mentioned recently that 
he was using fmt(1) for the project reports, and that could be a start.

>> Sure, someone[tm] might be able to do just that ;-). I welcome to review
>> and test patches that will work this out. But I do not have the time nor
>> focus at the moment to do that work. And yes I agree that things to make
>> it easier are welcomed and might lower the bar, but then again we do not
>> have that (yet?) and until that time we need to work with what we have
>> and how things have been going for the last period of time.
>
> It seems that igor can do some of the checking already;
>
> [remko at speeltuin /virtual/workspace/subversion/ports/security/vuxml]$ igor vuln.xml  | more
> vuln.xml:55:wrap long line:    <topic>HTMLDOC -- buffer overflow issues when reading AFM files[ ]and parsing page sizes</topic>
> vuln.xml:67:use two spaces at sentence start:       formatting bugs.[ ]Changes include:</p>
> vuln.xml:73:bad tag indent:[      ]</body>
> vuln.xml:96:wrap long line:        <blockquote[ ]cite="http://www.oracle.com/technetwork/topics/security/cpujan2014-1972949.html">
> vuln.xml:100:wrap long line:            users to affect confidentiality, integrity, and[ ]availability
> vuln.xml:103:bad tag indent:[      ]</body>
> vuln.xml:112:bad tag indent:[    ]</dates>
>
> Not yet perfect[tm] but it was not intended from start for vuxml, but we might lure wblock into perhaps have a look at that?

Sorry, I missed the earlier part of this thread, and am not sure what 
would need to be added.  As is, igor will check for whitespace problems, 
spelling, and indentation.  The last is a horrible hack, sometimes 
giving false positives with uglier usage of XML.  ( I've been trying to 
coax someone other than me to rewrite it for quite a while now.)

Some tags would need to be added to igor to check the indenting. Are 
there new tests that would need to be added?

One advantage of a formatting script is that it can just do what is 
desired with the input.  igor will warn about problems, but the user has 
to run it and then correct those problems.