From mboxrd@z Thu Jan 1 00:00:00 1970 From: a.hajda@samsung.com (Andrzej Hajda) Date: Tue, 07 Mar 2017 13:08:19 +0100 Subject: [Patch v2 11/11] Documention: v4l: Documentation for HEVC CIDs In-Reply-To: <1488532036-13044-12-git-send-email-smitha.t@samsung.com> References: <1488532036-13044-1-git-send-email-smitha.t@samsung.com> <1488532036-13044-12-git-send-email-smitha.t@samsung.com> Message-ID: <6c537c6a-0b87-0624-6770-73404972fb7a@samsung.com> To: linux-arm-kernel@lists.infradead.org List-Id: linux-arm-kernel.lists.infradead.org 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