From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752294AbdESRdS (ORCPT ); Fri, 19 May 2017 13:33:18 -0400 Received: from smtprelay0248.hostedemail.com ([216.40.44.248]:36058 "EHLO smtprelay.hostedemail.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1750748AbdESRdO (ORCPT ); Fri, 19 May 2017 13:33:14 -0400 X-Session-Marker: 6A6F6540706572636865732E636F6D X-Spam-Summary: 2,0,0,,d41d8cd98f00b204,joe@perches.com,:::::::::::::::::::::::,RULES_HIT:41:69:355:379:541:599:960:988:989:1260:1277:1311:1313:1314:1345:1359:1373:1437:1515:1516:1518:1534:1541:1593:1594:1711:1730:1747:1777:1792:2393:2559:2562:2828:3138:3139:3140:3141:3142:3354:3622:3865:3866:3867:3868:3871:3872:3874:4321:5007:6119:7875:7903:9040:10004:10400:10848:11232:11658:11914:12043:12291:12295:12683:12740:12760:12895:13069:13311:13357:13439:14181:14659:14721:14773:21080:21433:21450:21451:21626:30054:30056:30060:30070:30091,0,RBL:none,CacheIP:none,Bayesian:0.5,0.5,0.5,Netcheck:none,DomainCache:0,MSF:not bulk,SPF:,MSBL:0,DNSBL:none,Custom_rules:0:0:0,LFtime:2,LUA_SUMMARY:none X-HE-Tag: bears89_1bdc22d35765b X-Filterd-Recvd-Size: 3161 Message-ID: <1495189568.31562.34.camel@perches.com> Subject: Re: [PATCH 04/29] printk-formats.txt: standardize document format From: Joe Perches To: Mauro Carvalho Chehab , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , David Woodhouse , Brian Norris , Boris Brezillon , Marek Vasut , Richard Weinberger , Cyrille Pitchen , linux-mtd@lists.infradead.org In-Reply-To: <6c973f1a04299e7f637949f717ea7f6c9777b0b4.1495157082.git.mchehab@s-opensource.com> References: <6c973f1a04299e7f637949f717ea7f6c9777b0b4.1495157082.git.mchehab@s-opensource.com> Content-Type: text/plain; charset="ISO-8859-1" Date: Fri, 19 May 2017 03:26:08 -0700 Mime-Version: 1.0 X-Mailer: Evolution 3.22.6-1ubuntu1 Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Thu, 2017-05-18 at 22:25 -0300, Mauro Carvalho Chehab wrote: > Each text file under Documentation follows a different > format. Some doesn't even have titles! > > Change its representation to follow the adopted standard, > using ReST markups for it to be parseable by Sphinx: > > - add a title for the document; > - add markups for section titles; > - move authorship to the beginning and use :Author:; > - use right markup for tables; > - mark literals and literal blocks. I think the .rst markup is far uglier to read as text and harder to modify for new additions to %p given column alignments. For instance below, but other than that, the .rst is easier to read. > diff --git a/Documentation/printk-formats.txt b/Documentation/printk-formats.txt [] > @@ -1,139 +1,180 @@ > -If variable is of Type, use printk format specifier: > ---------------------------------------------------------- > - int %d or %x > - unsigned int %u or %x > - long %ld or %lx > - unsigned long %lu or %lx > - long long %lld or %llx > - unsigned long long %llu or %llx > - size_t %zu or %zx > - ssize_t %zd or %zx > - s32 %d or %x > - u32 %u or %x > - s64 %lld or %llx > - u64 %llu or %llx [] > +======================= =========================== > +If variable is of Type use printk format specifier > +======================= =========================== > +``int`` ``%d or %x`` > +``unsigned int`` ``%u or %x`` > +``long`` ``%ld or %lx`` > +``unsigned long`` ``%lu or %lx`` > +``long long`` ``%lld or %llx`` > +``unsigned long long`` ``%llu or %llx`` > +``size_t`` ``%zu or %zx`` > +``ssize_t`` ``%zd or %zx`` > +``s32`` ``%d or %x`` > +``u32`` ``%u or %x`` > +``s64`` ``%lld or %llx`` > +``u64`` ``%llu or %llx`` > +======================= ===========================