http://bugzilla.novell.com/show_bug.cgi?id=602330 http://bugzilla.novell.com/show_bug.cgi?id=602330#c0 Summary: Improve Pattern File with Correct URL and Comments Classification: openSUSE Product: openSUSE.org Version: unspecified Platform: Other OS/Version: Other Status: NEW Severity: Normal Priority: P5 - None Component: BuildService AssignedTo: bnc-team-screening@forge.provo.novell.com ReportedBy: thomas.schraitle@novell.com QAContact: adrian@novell.com CC: jsrain@novell.com Found By: Documentation Blocker: --- Hi, when creating a new pattern files in OBS, you usually run this command: $ osc meta pattern -e home:thomas-schraitle XML The command creates this output: <!-- See http://svn.opensuse.org/svn/zypp/trunk/libzypp/zypp/parser/yum/schema/patterns.rng --> <pattern> </pattern> I have some problems with this content: 1. The URL in the comment is broken. The patterns.rng is now located in Git under http://gitorious.org/opensuse/libzypp/blobs/master/zypp/parser/yum/schema/pa... 2. The XML file itself is incomplete. How can a user know what to include when (a) the comment is deadly wrong, and (b) have no documentation? I would suggest the following solution: 1. Switching one URL to another is probably s shortterm solution, but I would like to see a more permanent one: a URL (or better URI) for the schema should constant. It doesn't help the user if he has to search for the RNG schema (which I doubt it will ever happen). Nevertheless XML aficionados (like me :) ) would be happy if we can copy an URL into our XML editor and start writing. It should be possible the URL stays as it is regardless of SVN, Git, or the other new version system in town that is currently hyped. ;) 2. Even worse, without documentation or the RNG schema, it is impossible to know what to include. To improve usability, I would suggest the following: a) Include all namespaces in the root element! b) Insert a comment so the user has a chance to sees what he can insert: <!-- Documentation: http://en.opensuse.org/Libzypp/RNG-Schema Official URI: http://... urn:suse:... RNG-Schema: http://gitorious.org/opensuse/libzypp/blobs/raw/master/zypp/parser/yum/schema/pattern.rng RNC-Schema: http://gitorious.org/opensuse/libzypp/blobs/raw/master/zypp/parser/yum/schema/pattern.rnc --> <pattern xmlns:rpm="http://linux.duke.edu/metadata/rpm" xmlns="http://novell.com/package/metadata/suse/pattern"> <!-- Remove the comment and insert --> <!-- <name> </name> <summary> </summary> <description> </description> <uservisible/> <category lang="en"></category> --> <!-- Insert one or more of rpm:conflicts, rpm:requires, rpm:recommends, ... --> rpm:requires http://bugzilla.novell.com/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are on the CC list for the bug.