Re: [Intel-gfx] [PATCH 4/5] Documentation: drm: Convert KMS Properties HTML table to CALS
On Tue, 2015-09-01 at 14:56 -0300, Danilo Cesar Lemes de Paula wrote: > On 08/25/2015 01:10 PM, Graham Whaley wrote: > > On Tue, 2015-08-25 at 16:29 +0200, Daniel Vetter wrote: > > > On Tue, Aug 25, 2015 at 10:26:44AM +0100, Graham Whaley wrote: > > > > The KMS Properties table is in HTML format, which is not > > > > supported > > > > for building pdfdocs, resulting in the following types of > > > > errors: > > > > > > > > jade:/Documentation/DocBook/drm.xml:34413:15:E: there is no > > > > attribute > > > > "border" > > > > jade:/Documentation/DocBook/drm.xml:34413:31:E: there is no > > > > attribute > > > > "cellpadding" > > > > jade:/Documentation/DocBook/drm.xml:34413:47:E: there is no > > > > attribute > > > > "cellspacing" > > > > jade:/Documentation/DocBook/drm.xml:34414:7:E: document type > > > > does > > > > not > > > > allow element "tbody" here > > > > > > > > Convert the table over to a CALS format table > > > > > > Hm, long-term plan was to move this table into DOC: comments in > > > the > > > source-code using markdown, which we now have (at least in > > > drm-intel-nightly and also planned to be merged into 4.4). Since > > > this > > > is > > > both a lot of churn I'd like to get there in just 1 step ... > > > -Daniel > > First - I've just noted an erroneous debug comment (or two) left in > > this patch as well, so looks like I will have to re-issue the > > series > > anyway. > > > > OK. I guess this comes down to a matter of timing... > > From Danilos patch of: f6d6913 (drm/doc: Convert to markdown) > > we can see markdown does not natively support tables, and we'd have > > to > > make this a fixed width layout like the one in that patch I > > suspect. > > Danilo - any advice on how you did that other table conversion? I > > just > > did a pandoc docbook->markdown_github and it looks some way there - > > but > > of course seems to have not honored the multi-column items, of > > which > > there are a few. It's probably not too bad to fix up by hand - I'll > > see > > if I can get that to work... > > Hi Graham, > > To be honest I didn't have to do any conversion as that table was > already in the header file. I just added 4 spaces so it would be > transformed into fixed width. > > However, there's tool you can use to help you: http://pandoc.org/try/ > I did a lot of translation there. If your table doesn't have any > spancells, you can put the HTML code there and get the Markdown for > free. > > Danilo Hi, following this email should be an [RFC] patch with the subject: [RFC] Docs: drm: Move KMS properties table out to source files This is not a fix - it is an example to show that maybe this table does not migrate well to markdown. Danilo, if you have any thoughts about the 'quote expansion' detailed in the patch I'd be interested. Daniel, we should probably consider if moving this table to markdown will work out given the width of the table and the restrictions of having to use fixed width for multi-row markdown table representation. Graham ___ Intel-gfx mailing list Intel-gfx@lists.freedesktop.org http://lists.freedesktop.org/mailman/listinfo/intel-gfx
Re: [Intel-gfx] [PATCH 4/5] Documentation: drm: Convert KMS Properties HTML table to CALS
On Tue, 2015-09-01 at 14:56 -0300, Danilo Cesar Lemes de Paula wrote: > On 08/25/2015 01:10 PM, Graham Whaley wrote: > > On Tue, 2015-08-25 at 16:29 +0200, Daniel Vetter wrote: > > > On Tue, Aug 25, 2015 at 10:26:44AM +0100, Graham Whaley wrote: > > > > The KMS Properties table is in HTML format, which is not > > > > supported > > > > for building pdfdocs, resulting in the following types of > > > > errors: > > > > > > > > jade:/Documentation/DocBook/drm.xml:34413:15:E: there is no > > > > attribute > > > > "border" > > > > jade:/Documentation/DocBook/drm.xml:34413:31:E: there is no > > > > attribute > > > > "cellpadding" > > > > jade:/Documentation/DocBook/drm.xml:34413:47:E: there is no > > > > attribute > > > > "cellspacing" > > > > jade:/Documentation/DocBook/drm.xml:34414:7:E: document type > > > > does > > > > not > > > > allow element "tbody" here > > > > > > > > Convert the table over to a CALS format table > > > > > > Hm, long-term plan was to move this table into DOC: comments in > > > the > > > source-code using markdown, which we now have (at least in > > > drm-intel-nightly and also planned to be merged into 4.4). Since > > > this > > > is > > > both a lot of churn I'd like to get there in just 1 step ... > > > -Daniel > > First - I've just noted an erroneous debug comment (or two) left in > > this patch as well, so looks like I will have to re-issue the > > series > > anyway. > > > > OK. I guess this comes down to a matter of timing... > > From Danilos patch of: f6d6913 (drm/doc: Convert to markdown) > > we can see markdown does not natively support tables, and we'd have > > to > > make this a fixed width layout like the one in that patch I > > suspect. > > Danilo - any advice on how you did that other table conversion? I > > just > > did a pandoc docbook->markdown_github and it looks some way there - > > but > > of course seems to have not honored the multi-column items, of > > which > > there are a few. It's probably not too bad to fix up by hand - I'll > > see > > if I can get that to work... > > Hi Graham, > > To be honest I didn't have to do any conversion as that table was > already in the header file. I just added 4 spaces so it would be > transformed into fixed width. > > However, there's tool you can use to help you: http://pandoc.org/try/ > I did a lot of translation there. If your table doesn't have any > spancells, you can put the HTML code there and get the Markdown for > free. > > Danilo Thanks, I got to have a look at this yesterday. I did a text render from the html using 'links' that worked surprisingly well, but the table has many spancells (both vertical and horizontal), and some other issues arose. I'll do an email later with some details of what I've found, but right now I'm not hopeful that it will be practical to move that large KMS Properties table to markdown. More later. Graham ___ Intel-gfx mailing list Intel-gfx@lists.freedesktop.org http://lists.freedesktop.org/mailman/listinfo/intel-gfx
Re: [Intel-gfx] [PATCH 4/5] Documentation: drm: Convert KMS Properties HTML table to CALS
On 08/25/2015 01:10 PM, Graham Whaley wrote: > On Tue, 2015-08-25 at 16:29 +0200, Daniel Vetter wrote: >> On Tue, Aug 25, 2015 at 10:26:44AM +0100, Graham Whaley wrote: >>> The KMS Properties table is in HTML format, which is not supported >>> for building pdfdocs, resulting in the following types of errors: >>> >>> jade:/Documentation/DocBook/drm.xml:34413:15:E: there is no >>> attribute >>> "border" >>> jade:/Documentation/DocBook/drm.xml:34413:31:E: there is no >>> attribute >>> "cellpadding" >>> jade:/Documentation/DocBook/drm.xml:34413:47:E: there is no >>> attribute >>> "cellspacing" >>> jade:/Documentation/DocBook/drm.xml:34414:7:E: document type does >>> not >>> allow element "tbody" here >>> >>> Convert the table over to a CALS format table >> >> Hm, long-term plan was to move this table into DOC: comments in the >> source-code using markdown, which we now have (at least in >> drm-intel-nightly and also planned to be merged into 4.4). Since this >> is >> both a lot of churn I'd like to get there in just 1 step ... >> -Daniel > First - I've just noted an erroneous debug comment (or two) left in > this patch as well, so looks like I will have to re-issue the series > anyway. > > OK. I guess this comes down to a matter of timing... > From Danilos patch of: f6d6913 (drm/doc: Convert to markdown) > we can see markdown does not natively support tables, and we'd have to > make this a fixed width layout like the one in that patch I suspect. > Danilo - any advice on how you did that other table conversion? I just > did a pandoc docbook->markdown_github and it looks some way there - but > of course seems to have not honored the multi-column items, of which > there are a few. It's probably not too bad to fix up by hand - I'll see > if I can get that to work... Hi Graham, To be honest I didn't have to do any conversion as that table was already in the header file. I just added 4 spaces so it would be transformed into fixed width. However, there's tool you can use to help you: http://pandoc.org/try/ I did a lot of translation there. If your table doesn't have any spancells, you can put the HTML code there and get the Markdown for free. Danilo ___ Intel-gfx mailing list Intel-gfx@lists.freedesktop.org http://lists.freedesktop.org/mailman/listinfo/intel-gfx
Re: [Intel-gfx] [PATCH 4/5] Documentation: drm: Convert KMS Properties HTML table to CALS
On Tue, Aug 25, 2015 at 05:10:54PM +0100, Graham Whaley wrote: > On Tue, 2015-08-25 at 16:29 +0200, Daniel Vetter wrote: > > On Tue, Aug 25, 2015 at 10:26:44AM +0100, Graham Whaley wrote: > > > The KMS Properties table is in HTML format, which is not supported > > > for building pdfdocs, resulting in the following types of errors: > > > > > > jade:/Documentation/DocBook/drm.xml:34413:15:E: there is no > > > attribute > > > "border" > > > jade:/Documentation/DocBook/drm.xml:34413:31:E: there is no > > > attribute > > > "cellpadding" > > > jade:/Documentation/DocBook/drm.xml:34413:47:E: there is no > > > attribute > > > "cellspacing" > > > jade:/Documentation/DocBook/drm.xml:34414:7:E: document type does > > > not > > > allow element "tbody" here > > > > > > Convert the table over to a CALS format table > > > > Hm, long-term plan was to move this table into DOC: comments in the > > source-code using markdown, which we now have (at least in > > drm-intel-nightly and also planned to be merged into 4.4). Since this > > is > > both a lot of churn I'd like to get there in just 1 step ... > > -Daniel > First - I've just noted an erroneous debug comment (or two) left in > this patch as well, so looks like I will have to re-issue the series > anyway. > > OK. I guess this comes down to a matter of timing... > From Danilos patch of: f6d6913 (drm/doc: Convert to markdown) > we can see markdown does not natively support tables, and we'd have to > make this a fixed width layout like the one in that patch I suspect. > Danilo - any advice on how you did that other table conversion? I just > did a pandoc docbook->markdown_github and it looks some way there - but > of course seems to have not honored the multi-column items, of which > there are a few. It's probably not too bad to fix up by hand - I'll see > if I can get that to work... > Any clue to where in the source file DOC: sections it would want to > live if I get it formatted - I don't see an obvious !include near the > table in the .tmpl file to piggyback. Yeah it's a bit more involved and probably a bigger series. We might even want to split up this table into per-feature stuff since the current one doesn't really scale. Otoh that can be done later on. What I'd do is split it into sections (generic, i915, ...) so that we can avoid the row-spanning as much as possible, and then just place it somewhere into drm_crtc.c - that's the grab-bag for all things modeset (which properties are a part of). Maybe longer-term we want to split out a drm_properties.c or something like that with the pile of support code we have already, plus this kerneldoc. -Daniel > > Graham > > > > > > > > Signed-off-by: Graham Whaley > > > --- > > > Documentation/DocBook/drm.tmpl | 1866 > > > > > > 1 file changed, 937 insertions(+), 929 deletions(-) > > > > > > diff --git a/Documentation/DocBook/drm.tmpl > > > b/Documentation/DocBook/drm.tmpl > > > index 2e05a79..e5bfdd8 100644 > > > --- a/Documentation/DocBook/drm.tmpl > > > +++ b/Documentation/DocBook/drm.tmpl > > > @@ -2580,935 +2580,943 @@ void intel_crt_init(struct drm_device > > > *dev) > > >and an initial instance value. > > > > > > > > > - Existing KMS Properties > > > - > > > - The following table gives description of drm properties > > > exposed by various > > > - modules/drivers. > > > - > > > - > > > - > > > - > > > - Owner Module/Drivers > > > - Group > > > - Property Name > > > - Type > > > - Property Values > > > - Object attached > > > - Description/Restrictions > > > - > > > - > > > - DRM > > > - Generic > > > - “rotation” > > > - BITMASK > > > - { 0, "rotate-0" }, > > > - { 1, "rotate-90" }, > > > - { 2, "rotate-180" }, > > > - { 3, "rotate-270" }, > > > - { 4, "reflect-x" }, > > > - { 5, "reflect-y" } > > > - CRTC, Plane > > > - rotate-(degrees) rotates the image by > > > the specified amount in degrees > > > - in counter clockwise direction. reflect-x and reflect-y > > > reflects the > > > - image along the specified axis prior to rotation > > > - > > > - > > > - Connector > > > - “EDID” > > > - BLOB | IMMUTABLE > > > - 0 > > > - Connector > > > - Contains id of edid blob ptr > > > object. > > > - > > > - > > > - “DPMS” > > > - ENUM > > > - { “On”, “Standby”, “Suspend”, “Off” > > > } > > > - Connector > > > - Contains DPMS operation mode value. > > > - > > > - > > > - “PATH” > > > - BLOB | IMMUTABLE > > > - 0 > > > - Connector > > > - Contains topology path to a > > > connector. > > > - > > > - > > > - “TILE” > > > - BLOB | IMMUTABLE > > > - 0 > > > - Connector > > > - Contains tiling information for a > > > connector. > > > - > > > - > > > - “CRTC_ID” > > > - OBJECT > > > - DRM_MODE_OBJECT_CRTC > > > - Connector > > > - CRTC that connector is attached to > > > (atomic) > > > - > > > - > > > - Plane > > > - “type” > > > - ENUM | IMMUTABLE > > > - { "Overlay", "Primary", "Cursor" } > > > - Plane > > > - Plane type > > > - > > >
Re: [Intel-gfx] [PATCH 4/5] Documentation: drm: Convert KMS Properties HTML table to CALS
On Tue, 2015-08-25 at 16:29 +0200, Daniel Vetter wrote: > On Tue, Aug 25, 2015 at 10:26:44AM +0100, Graham Whaley wrote: > > The KMS Properties table is in HTML format, which is not supported > > for building pdfdocs, resulting in the following types of errors: > > > > jade:/Documentation/DocBook/drm.xml:34413:15:E: there is no > > attribute > > "border" > > jade:/Documentation/DocBook/drm.xml:34413:31:E: there is no > > attribute > > "cellpadding" > > jade:/Documentation/DocBook/drm.xml:34413:47:E: there is no > > attribute > > "cellspacing" > > jade:/Documentation/DocBook/drm.xml:34414:7:E: document type does > > not > > allow element "tbody" here > > > > Convert the table over to a CALS format table > > Hm, long-term plan was to move this table into DOC: comments in the > source-code using markdown, which we now have (at least in > drm-intel-nightly and also planned to be merged into 4.4). Since this > is > both a lot of churn I'd like to get there in just 1 step ... > -Daniel First - I've just noted an erroneous debug comment (or two) left in this patch as well, so looks like I will have to re-issue the series anyway. OK. I guess this comes down to a matter of timing... From Danilos patch of: f6d6913 (drm/doc: Convert to markdown) we can see markdown does not natively support tables, and we'd have to make this a fixed width layout like the one in that patch I suspect. Danilo - any advice on how you did that other table conversion? I just did a pandoc docbook->markdown_github and it looks some way there - but of course seems to have not honored the multi-column items, of which there are a few. It's probably not too bad to fix up by hand - I'll see if I can get that to work... Any clue to where in the source file DOC: sections it would want to live if I get it formatted - I don't see an obvious !include near the table in the .tmpl file to piggyback. Graham > > > > > Signed-off-by: Graham Whaley > > --- > > Documentation/DocBook/drm.tmpl | 1866 > > > > 1 file changed, 937 insertions(+), 929 deletions(-) > > > > diff --git a/Documentation/DocBook/drm.tmpl > > b/Documentation/DocBook/drm.tmpl > > index 2e05a79..e5bfdd8 100644 > > --- a/Documentation/DocBook/drm.tmpl > > +++ b/Documentation/DocBook/drm.tmpl > > @@ -2580,935 +2580,943 @@ void intel_crt_init(struct drm_device > > *dev) > >and an initial instance value. > > > > > > - Existing KMS Properties > > - > > - The following table gives description of drm properties > > exposed by various > > - modules/drivers. > > - > > - > > - > > - > > - Owner Module/Drivers > > - Group > > - Property Name > > - Type > > - Property Values > > - Object attached > > - Description/Restrictions > > - > > - > > - DRM > > - Generic > > - “rotation” > > - BITMASK > > - { 0, "rotate-0" }, > > - { 1, "rotate-90" }, > > - { 2, "rotate-180" }, > > - { 3, "rotate-270" }, > > - { 4, "reflect-x" }, > > - { 5, "reflect-y" } > > - CRTC, Plane > > - rotate-(degrees) rotates the image by > > the specified amount in degrees > > - in counter clockwise direction. reflect-x and reflect-y > > reflects the > > - image along the specified axis prior to rotation > > - > > - > > - Connector > > - “EDID” > > - BLOB | IMMUTABLE > > - 0 > > - Connector > > - Contains id of edid blob ptr > > object. > > - > > - > > - “DPMS” > > - ENUM > > - { “On”, “Standby”, “Suspend”, “Off” > > } > > - Connector > > - Contains DPMS operation mode value. > > - > > - > > - “PATH” > > - BLOB | IMMUTABLE > > - 0 > > - Connector > > - Contains topology path to a > > connector. > > - > > - > > - “TILE” > > - BLOB | IMMUTABLE > > - 0 > > - Connector > > - Contains tiling information for a > > connector. > > - > > - > > - “CRTC_ID” > > - OBJECT > > - DRM_MODE_OBJECT_CRTC > > - Connector > > - CRTC that connector is attached to > > (atomic) > > - > > - > > - Plane > > - “type” > > - ENUM | IMMUTABLE > > - { "Overlay", "Primary", "Cursor" } > > - Plane > > - Plane type > > - > > - > > - “SRC_X” > > - RANGE > > - Min=0, Max=UINT_MAX > > - Plane > > - Scanout source x coordinate in 16.16 > > fixed point (atomic) > > - > > - > > - “SRC_Y” > > - RANGE > > - Min=0, Max=UINT_MAX > > - Plane > > - Scanout source y coordinate in 16.16 > > fixed point (atomic) > > - > > - > > - “SRC_W” > > - RANGE > > - Min=0, Max=UINT_MAX > > - Plane > > - Scanout source width in 16.16 fixed > > point (atomic) > > - > > - > > - “SRC_H” > > - RANGE > > - Min=0, Max=UINT_MAX > > - Plane > > - Scanout source height in 16.16 fixed > > point (atomic) > > - > > - > > - “CRTC_X” > > - SIGNED_RANGE > > - Min=INT_MIN, Max=INT_MAX > > - Plane > > - Scanout CRTC (destination) x coordinate > > (atomic) > > - > > - > > - “CRTC_
Re: [Intel-gfx] [PATCH 4/5] Documentation: drm: Convert KMS Properties HTML table to CALS
On Tue, Aug 25, 2015 at 10:26:44AM +0100, Graham Whaley wrote: > The KMS Properties table is in HTML format, which is not supported > for building pdfdocs, resulting in the following types of errors: > > jade:/Documentation/DocBook/drm.xml:34413:15:E: there is no attribute > "border" > jade:/Documentation/DocBook/drm.xml:34413:31:E: there is no attribute > "cellpadding" > jade:/Documentation/DocBook/drm.xml:34413:47:E: there is no attribute > "cellspacing" > jade:/Documentation/DocBook/drm.xml:34414:7:E: document type does not > allow element "tbody" here > > Convert the table over to a CALS format table Hm, long-term plan was to move this table into DOC: comments in the source-code using markdown, which we now have (at least in drm-intel-nightly and also planned to be merged into 4.4). Since this is both a lot of churn I'd like to get there in just 1 step ... -Daniel > > Signed-off-by: Graham Whaley > --- > Documentation/DocBook/drm.tmpl | 1866 > > 1 file changed, 937 insertions(+), 929 deletions(-) > > diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl > index 2e05a79..e5bfdd8 100644 > --- a/Documentation/DocBook/drm.tmpl > +++ b/Documentation/DocBook/drm.tmpl > @@ -2580,935 +2580,943 @@ void intel_crt_init(struct drm_device *dev) >and an initial instance value. > > > - Existing KMS Properties > - > - The following table gives description of drm properties exposed by > various > - modules/drivers. > - > - > - > - > - Owner Module/Drivers > - Group > - Property Name > - Type > - Property Values > - Object attached > - Description/Restrictions > - > - > - DRM > - Generic > - “rotation” > - BITMASK > - { 0, "rotate-0" }, > - { 1, "rotate-90" }, > - { 2, "rotate-180" }, > - { 3, "rotate-270" }, > - { 4, "reflect-x" }, > - { 5, "reflect-y" } > - CRTC, Plane > - rotate-(degrees) rotates the image by the specified > amount in degrees > - in counter clockwise direction. reflect-x and reflect-y reflects the > - image along the specified axis prior to rotation > - > - > - Connector > - “EDID” > - BLOB | IMMUTABLE > - 0 > - Connector > - Contains id of edid blob ptr object. > - > - > - “DPMS” > - ENUM > - { “On”, “Standby”, “Suspend”, “Off” } > - Connector > - Contains DPMS operation mode value. > - > - > - “PATH” > - BLOB | IMMUTABLE > - 0 > - Connector > - Contains topology path to a connector. > - > - > - “TILE” > - BLOB | IMMUTABLE > - 0 > - Connector > - Contains tiling information for a connector. > - > - > - “CRTC_ID” > - OBJECT > - DRM_MODE_OBJECT_CRTC > - Connector > - CRTC that connector is attached to (atomic) > - > - > - Plane > - “type” > - ENUM | IMMUTABLE > - { "Overlay", "Primary", "Cursor" } > - Plane > - Plane type > - > - > - “SRC_X” > - RANGE > - Min=0, Max=UINT_MAX > - Plane > - Scanout source x coordinate in 16.16 fixed point > (atomic) > - > - > - “SRC_Y” > - RANGE > - Min=0, Max=UINT_MAX > - Plane > - Scanout source y coordinate in 16.16 fixed point > (atomic) > - > - > - “SRC_W” > - RANGE > - Min=0, Max=UINT_MAX > - Plane > - Scanout source width in 16.16 fixed point > (atomic) > - > - > - “SRC_H” > - RANGE > - Min=0, Max=UINT_MAX > - Plane > - Scanout source height in 16.16 fixed point > (atomic) > - > - > - “CRTC_X” > - SIGNED_RANGE > - Min=INT_MIN, Max=INT_MAX > - Plane > - Scanout CRTC (destination) x coordinate (atomic) > - > - > - “CRTC_Y” > - SIGNED_RANGE > - Min=INT_MIN, Max=INT_MAX > - Plane > - Scanout CRTC (destination) y coordinate (atomic) > - > - > - “CRTC_W” > - RANGE > - Min=0, Max=UINT_MAX > - Plane > - Scanout CRTC (destination) width (atomic) > - > - > - “CRTC_H” > - RANGE > - Min=0, Max=UINT_MAX > - Plane > - Scanout CRTC (destination) height (atomic) > - > - > - “FB_ID” > - OBJECT > - DRM_MODE_OBJECT_FB > - Plane > - Scanout framebuffer (atomic) > - > - > - “CRTC_ID” > - OBJECT > - DRM_MODE_OBJECT_CRTC > - Plane > - CRTC that plane is attached to (atomic) > - > - > - DVI-I > - “subconnector” > - ENUM > - { “Unknown”, “DVI-D”, “DVI-A” } > - Connector > - TBD > - > - > - “select subconnector” > - ENUM > - { “Automatic”, “DVI-D”, “DVI-A” } > - Connector > - TBD > - > - > - TV > - “subconnector” > - ENUM > - { "Unknown", "Composite", "SVIDEO", "Component", > "SCART" }