From mboxrd@z Thu Jan 1 00:00:00 1970 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932430AbeAJF0Z (ORCPT + 1 other); Wed, 10 Jan 2018 00:26:25 -0500 Received: from imap.thunk.org ([74.207.234.97]:57586 "EHLO imap.thunk.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932178AbeAJF0Y (ORCPT ); Wed, 10 Jan 2018 00:26:24 -0500 Date: Wed, 10 Jan 2018 00:26:19 -0500 From: Theodore Ts'o To: "Tobin C. Harding" Cc: Jan Kara , linux-ext4@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH v2] jbd2: fix sphinx kerel-doc build warnings Message-ID: <20180110052619.GG5809@thunk.org> Mail-Followup-To: Theodore Ts'o , "Tobin C. Harding" , Jan Kara , linux-ext4@vger.kernel.org, linux-kernel@vger.kernel.org References: <1515548549-25866-1-git-send-email-me@tobin.cc> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <1515548549-25866-1-git-send-email-me@tobin.cc> User-Agent: Mutt/1.9.2 (2017-12-15) X-SA-Exim-Connect-IP: X-SA-Exim-Mail-From: tytso@thunk.org X-SA-Exim-Scanned: No (on imap.thunk.org); SAEximRunCond expanded to false Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Return-Path: On Wed, Jan 10, 2018 at 12:42:29PM +1100, Tobin C. Harding wrote: > Sphinx emits various (26) warnings when building make target 'htmldocs'. > Currently struct definitions contain duplicate documentation, some as > kernel-docs and some as standard c89 comments. We can reduce > duplication while cleaning up the kernel docs. > > Move all kernel-docs to right above each struct member. Use the set of > all existing comments (kernel-doc and c89). Add documentation for > missing struct members and function arguments. > > Signed-off-by: Tobin C. Harding Thanks, applied. I did fix up a few of your newly added doc strings. - Ted