Re: [PATCH] Documentation: DocBook DRM framework documentation
Hi Laurent, I've used "behavior" when copying sections from the existing documentation. I'll unify that. Does kernel documentation favour one of the spellings ? Looking at v3.5, the American spelling is more common, but looking at how you spell favour, I think I know which one you favor :) linux-git$ grep -ri behaviour Documentation/ | wc -l 150 linux-git$ grep -ri behavior Documentation/ | wc -l 269 -Michael MATRIX VISION GmbH, Talstrasse 16, DE-71570 Oppenweiler Registergericht: Amtsgericht Stuttgart, HRB 271090 Geschaeftsfuehrer: Gerhard Thullner, Werner Armingeon, Uwe Furtner, Erhard Meier ___ dri-devel mailing list dri-devel@lists.freedesktop.org http://lists.freedesktop.org/mailman/listinfo/dri-devel
[PATCH] Documentation: DocBook DRM framework documentation
Hi Laurent, > I've used "behavior" when copying sections from the existing documentation. > I'll unify that. Does kernel documentation favour one of the spellings ? > Looking at v3.5, the American spelling is more common, but looking at how you spell favour, I think I know which one you favor :) linux-git$ grep -ri behaviour Documentation/ | wc -l 150 linux-git$ grep -ri behavior Documentation/ | wc -l 269 -Michael MATRIX VISION GmbH, Talstrasse 16, DE-71570 Oppenweiler Registergericht: Amtsgericht Stuttgart, HRB 271090 Geschaeftsfuehrer: Gerhard Thullner, Werner Armingeon, Uwe Furtner, Erhard Meier
[PATCH] Documentation: DocBook DRM framework documentation
Hi Laurent, At a quick glance I noticed a couple of things: On 07/13/2012 02:00 AM, Laurent Pinchart wrote: [snip] > + > + The drm_driver structure contains static > + information that describe the driver and features it supports, and s/describe/describes/ > + pointers to methods that the DRM core will call to implement the DRM > API. > + We will first go through the drm_driver static > + information fields, and will then describe individual operations in > + details as they get used in later sections. > > - > > - Driver private & performance counters > - > - The driver private hangs off the main drm_device structure and > - can be used for tracking various device-specific bits of > - information, like register offsets, command buffer status, > - register state for suspend/resume, etc. At load time, a > - driver may simply allocate one and set drm_device.dev_priv > - appropriately; it should be freed and drm_device.dev_priv set > - to NULL when the driver is unloaded. > - > + Driver Information > + > +Driver Features > + > + Drivers inform the DRM core about their requirements and supported > + features by setting appropriate flags in the > + driver_features field. Since those flags > + influence the DRM core behaviour since registration time, most of > them Elsewhere you use the American spelling "behavior". [snip] > + > +Major, Minor and Patchlevel > +int major; > + int minor; > + int patchlevel; In my browser, "int minor" and "int patchlevel" look indented, whereas "int major" does not. Looks like they _should_ be indented identically. Don't know how you fix this or if you even see the same problem. > + > + The DRM core identifies driver versions by a major, minor and patch > + level triplet. The information is printed to the kernel log at > + initialization time and passed to userspace through the > + DRM_IOCTL_VERSION ioctl. > + > + > + The major and minor numbers are also used to verify the requested > driver > + API version passed to DRM_IOCTL_SET_VERSION. When the driver API > changes > + between minor versions, applications can call > DRM_IOCTL_SET_VERSION to > + select a specific version of the API. If the requested major isn't > equal > + to the driver major, or the requested minor is larger than the > driver > + minor, the DRM_IOCTL_SET_VERSION call will return an error. > Otherwise > + the driver's set_version() method will be called with the requested > + version. > + > + > + > +Name, Description and Date > +char *name; > + char *desc; > + char *date; Same indentation issue here. [snip] > + > +The mode_fixup operation should reject > the > +mode if it can't reasonably use it. The definition of > "reasonable" > +is currently fuzzy in this context. One possible behaviour would > be maybe s/behaviour/behavior/ again MATRIX VISION GmbH, Talstrasse 16, DE-71570 Oppenweiler Registergericht: Amtsgericht Stuttgart, HRB 271090 Geschaeftsfuehrer: Gerhard Thullner, Werner Armingeon, Uwe Furtner, Erhard Meier
Re: [PATCH] Documentation: DocBook DRM framework documentation
Hi Laurent, At a quick glance I noticed a couple of things: On 07/13/2012 02:00 AM, Laurent Pinchart wrote: [snip] + + The drm_driver structure contains static + information that describe the driver and features it supports, and s/describe/describes/ + pointers to methods that the DRM core will call to implement the DRM API. + We will first go through the drm_driver static + information fields, and will then describe individual operations in + details as they get used in later sections. - - Driver private & performance counters - - The driver private hangs off the main drm_device structure and - can be used for tracking various device-specific bits of - information, like register offsets, command buffer status, - register state for suspend/resume, etc. At load time, a - driver may simply allocate one and set drm_device.dev_priv - appropriately; it should be freed and drm_device.dev_priv set - to NULL when the driver is unloaded. - + Driver Information + +Driver Features + + Drivers inform the DRM core about their requirements and supported + features by setting appropriate flags in the + driver_features field. Since those flags + influence the DRM core behaviour since registration time, most of them Elsewhere you use the American spelling "behavior". [snip] + +Major, Minor and Patchlevel +int major; + int minor; + int patchlevel; In my browser, "int minor" and "int patchlevel" look indented, whereas "int major" does not. Looks like they _should_ be indented identically. Don't know how you fix this or if you even see the same problem. + + The DRM core identifies driver versions by a major, minor and patch + level triplet. The information is printed to the kernel log at + initialization time and passed to userspace through the + DRM_IOCTL_VERSION ioctl. + + + The major and minor numbers are also used to verify the requested driver + API version passed to DRM_IOCTL_SET_VERSION. When the driver API changes + between minor versions, applications can call DRM_IOCTL_SET_VERSION to + select a specific version of the API. If the requested major isn't equal + to the driver major, or the requested minor is larger than the driver + minor, the DRM_IOCTL_SET_VERSION call will return an error. Otherwise + the driver's set_version() method will be called with the requested + version. + + + +Name, Description and Date +char *name; + char *desc; + char *date; Same indentation issue here. [snip] + +The mode_fixup operation should reject the +mode if it can't reasonably use it. The definition of "reasonable" +is currently fuzzy in this context. One possible behaviour would be maybe s/behaviour/behavior/ again MATRIX VISION GmbH, Talstrasse 16, DE-71570 Oppenweiler Registergericht: Amtsgericht Stuttgart, HRB 271090 Geschaeftsfuehrer: Gerhard Thullner, Werner Armingeon, Uwe Furtner, Erhard Meier ___ dri-devel mailing list dri-devel@lists.freedesktop.org http://lists.freedesktop.org/mailman/listinfo/dri-devel
