Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752374AbdLHAqd (ORCPT ); Thu, 7 Dec 2017 19:46:33 -0500 Received: from out3-smtp.messagingengine.com ([66.111.4.27]:57387 "EHLO out3-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750993AbdLHAqb (ORCPT ); Thu, 7 Dec 2017 19:46:31 -0500 X-ME-Sender: Date: Fri, 8 Dec 2017 11:46:27 +1100 From: "Tobin C. Harding" To: Kees Cook Cc: Jonathan Corbet , Randy Dunlap , Andrew Murray , linux-doc@vger.kernel.org, LKML Subject: Re: [PATCH] doc: convert printk-formats.txt to rst Message-ID: <20171208004627.GW2191@eros> References: <1512524729-16051-1-git-send-email-me@tobin.cc> <20171207234402.GT2191@eros> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: X-Mailer: Mutt 1.5.24 (2015-08-30) User-Agent: Mutt/1.5.24 (2015-08-30) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1468 Lines: 36 On Thu, Dec 07, 2017 at 04:19:56PM -0800, Kees Cook wrote: > On Thu, Dec 7, 2017 at 3:44 PM, Tobin C. Harding wrote: > > Cheers Kees. FTR, changes to implement are: > > > > - Fix the capitalization of 'kernel'. > > I don't really have an opinion about which way is right. I personally > don't capitalize it unless I speak about it as a single thing "The > Linux Kernel". In this case I just noticed you had mixed usage. > > > - Add ESCAPE_* flags back into kernel-docs in lib/vsprintf.c > > I actually meant each of the sections. Several of the formats have > per-item breakdowns that went missing in the new kernel-doc (ESCAPE_* > was just an example). Oh dear, you don't like that. This is actually the part of the patch that I was least sure about doing. I'm happy to revert, can I give you my thought process for comment? When the kernel-docs get included into printk-formats.rst it seems overly verbose to have all the information given twice. And then it seems odd to bother having the extra descriptions in printk-formats.rst if _all_ the required information is already in the kernel-docs? So I guessed that it would be nice for devs to get a bit of a hint at the specifiers when having lib/vsprintf.c open (and they have the code too) then if they needed more information going to printk-formats.rst. Also, since there is more space in printk-fomats.rst the info can be spaced better and easier to read. Your thoughts? thanks, Tobin.