From mboxrd@z Thu Jan 1 00:00:00 1970 From: Laurent Pinchart Subject: Re: [PATCH 1/1] Documentation: drm: describing drm properties exposed by various drivers Date: Mon, 10 Mar 2014 15:36:06 +0100 Message-ID: <2919182.UBDg5nOr7Z@avalon> References: <1394016990-5218-1-git-send-email-sagar.a.kamble@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7Bit Return-path: In-Reply-To: Sender: linux-doc-owner@vger.kernel.org To: Daniel Vetter Cc: Sagar Arun Kamble , intel-gfx , Rob Landley , Dave Airlie , Laurent Pinchart , David Herrmann , Alex Deucher , Ville =?ISO-8859-1?Q?Syrj=E4l=E4?= , "Purushothaman, Vijay A" , linux-doc@vger.kernel.org List-Id: intel-gfx@lists.freedesktop.org Hi Daniel, On Monday 10 March 2014 06:21:49 Daniel Vetter wrote: > On Wed, Mar 5, 2014 at 11:56 AM, wrote: > > + > > + > > + > > + > > + > > + > > + > > + > > + > > + > > + > > + > > In my opinion this is a horrible way to write property documentations > - explicitly constructing html tables is error prone and really hard > to read in the source. Imo docbook in general is rather horrible, > which is way I write almost all my docs as kerneldoc ;-) > > I think a simple asciidoc/markdown would be much simpler, with a bit > of free-form structure to group properties into relevant groups. > Long-term we might even need to split it up into different spec files > to keep a good overview. Docbook is indeed hard to read and write when it comes to such tables. However I like having the properties documented in the DRM core documentation. Maybe we could come up with a simpler text format that would be transformed into docbook when compiling the documentation ? -- Regards, Laurent Pinchart
Owner Module/DriversGroupProperty ObjectProperty NameTypeProperty ValuesObject attachedDescription