From mboxrd@z Thu Jan 1 00:00:00 1970 Return-path: Received: from mailout3.samsung.com ([203.254.224.33]:39741 "EHLO mailout3.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751060AbdCNLjy (ORCPT ); Tue, 14 Mar 2017 07:39:54 -0400 Received: from epcas5p1.samsung.com (unknown [182.195.41.39]) by mailout3.samsung.com (Oracle Communications Messaging Server 7.0.5.31.0 64bit (built May 5 2014)) with ESMTP id <0OMS033YXZ2GLK60@mailout3.samsung.com> for linux-media@vger.kernel.org; Tue, 14 Mar 2017 20:39:52 +0900 (KST) Subject: Re: [Patch v2 11/11] Documention: v4l: Documentation for HEVC CIDs From: Smitha T Murthy To: Andrzej Hajda Cc: linux-arm-kernel@lists.infradead.org, linux-media@vger.kernel.org, linux-kernel@vger.kernel.org, kyungmin.park@samsung.com, kamil@wypas.org, jtp.park@samsung.com, mchehab@kernel.org, pankaj.dubey@samsung.com, krzk@kernel.org, m.szyprowski@samsung.com, s.nawrocki@samsung.com In-reply-to: <6c537c6a-0b87-0624-6770-73404972fb7a@samsung.com> Date: Tue, 14 Mar 2017 17:11:53 +0530 Message-id: <1489491713.27807.144.camel@smitha-fedora> MIME-version: 1.0 Content-transfer-encoding: 7bit Content-type: text/plain; charset=utf-8 References: <1488532036-13044-1-git-send-email-smitha.t@samsung.com> <1488532036-13044-12-git-send-email-smitha.t@samsung.com> <6c537c6a-0b87-0624-6770-73404972fb7a@samsung.com> Sender: linux-media-owner@vger.kernel.org List-ID: On Tue, 2017-03-07 at 13:08 +0100, Andrzej Hajda wrote: > On 03.03.2017 10:07, Smitha T Murthy wrote: > > Added V4l2 controls for HEVC encoder > > It should be rather "Document controls for HEVC encoder" or sth similar. > > In general most of comments are in previous patch. > Few additional comments: > - please be careful about control names - they are exported to userspace > and becomes ABI, so it will be difficult to change them later (this > comment is rather to previous patch), > - please provide good documentation as for most users this documentation > will be the only available source of information, > - in short: bugs in the driver can be easily fixed(usually), wrong > control names will be hard to fix, weak documentation will prevent using it. > > And regarding this patch: > - please expand all acronyms (pb, tmv, BIT,...), > - please consider using menu instead of numbers for profile, level, > tier, types, generally everywhere where control value enumerates > 'things' and is not a pure number (coefficient, counter,...), > - if control is per-frame please drop it, V4L2 does not support it at > the moment ( I suppose ), > > Regards > Andrzej > > Ok I will change the patch description. I will try to document each control more elaborately and check the control names again. I do understand your concern regarding the wrong documentation, I will try to make more understandable and helpful. I will expand the macro names in the next version. I will create a menu for controls where it is applicable. Thank you so much for your review. Regards, Smitha >