From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933171AbeEHS3K (ORCPT ); Tue, 8 May 2018 14:29:10 -0400 Received: from bombadil.infradead.org ([198.137.202.133]:51396 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754370AbeEHS3H (ORCPT ); Tue, 8 May 2018 14:29:07 -0400 Date: Tue, 8 May 2018 15:28:51 -0300 From: Mauro Carvalho Chehab To: Jani Nikula Cc: Andrea Parri , Linux Doc Mailing List , linux-kernel@vger.kernel.org, Jonathan Corbet , Alan Stern , Andrea Parri , Will Deacon , Peter Zijlstra , Boqun Feng , Nicholas Piggin , David Howells , Jade Alglave , Luc Maranget , "Paul E. McKenney" , Akira Yokosawa , Matthew Wilcox , Jeff Layton , Randy Dunlap , Elena Reshetova , "Tobin C. Harding" Subject: Re: [PATCH 05/18] docs: core-api: add cachetlb documentation Message-ID: <20180508152851.11f39370@vento.lan> In-Reply-To: <20180508150507.284ef477@vento.lan> References: <07b59879d34502828467f0190f941e23e08fdc81.1525684985.git.mchehab+samsung@kernel.org> <20180507122937.GA5813@andrea> <87y3gu43d3.fsf@intel.com> <20180508150507.284ef477@vento.lan> X-Mailer: Claws Mail 3.16.0 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Em Tue, 8 May 2018 15:05:07 -0300 Mauro Carvalho Chehab escreveu: > Em Tue, 08 May 2018 17:40:56 +0300 > Jani Nikula escreveu: > > > On Mon, 07 May 2018, Andrea Parri wrote: > > > On Mon, May 07, 2018 at 06:35:41AM -0300, Mauro Carvalho Chehab wrote: > > >> The cachetlb.txt is already in ReST format. So, move it to the > > >> core-api guide, where it belongs. > > >> > > >> Signed-off-by: Mauro Carvalho Chehab > > >> --- > > >> Documentation/00-INDEX | 2 -- > > >> Documentation/{cachetlb.txt => core-api/cachetlb.rst} | 0 > > >> Documentation/core-api/index.rst | 1 + > > >> Documentation/memory-barriers.txt | 2 +- > > >> Documentation/translations/ko_KR/memory-barriers.txt | 2 +- > > >> 5 files changed, 3 insertions(+), 4 deletions(-) > > >> rename Documentation/{cachetlb.txt => core-api/cachetlb.rst} (100%) > > > > > > I see a few "inline" references to the .txt file in -rc4 (see below): > > > I am not sure if you managed to update them too. > > > > Side note, there's scripts/documentation-file-ref-check to grep the > > kernel tree for things that look like file references to Documentation/* > > and complain if they don't exist. > > > > I get about 350+ hits with that, patches welcome! ;) > > This small script fixes a bunch of such errors: > > scripts/documentation-file-ref-check 2>broken_refs > for i in $(cat broken_refs|cut -d: -f 2|grep -v devicetree|sort|uniq|grep \\.txt); do > rst=$(basename $i) > rst=${rst/.txt/.rst} > f=$(find . -name $rst) > f=${f#./} > if [ "$f" != "" ]; then > echo "Replacing $i to $f" > for j in $(git grep -l $i); do > sed "s@$i@$f@g" -i $j > done > fi > done It follows an improvement to the above script that shows also what it didn't find as a ReST file, and the ones that have common names with multiple matches. I guess we could integrate something like that at scripts/documentation-file-ref-check, in order to allow auto-correcting renamed .txt files. Regards, Mauro #!/bin/bash scripts/documentation-file-ref-check 2>broken_refs for i in $(cat broken_refs|cut -d: -f 2|grep -v devicetree|sort|uniq|grep \\.txt); do rst=$(basename $i) rst=${rst/.txt/.rst} f=$(find . -name $rst) if [ "$f" == "" ]; then echo "ERROR: Didn't find a .rst replacement for $i" elif [ "$(echo $f | grep ' ')" != "" ]; then echo "ERROR: Found multiple possible replacements for $i:" for j in $f; do echo " $j" done else echo "Replacing $i to $f" f=${f#./} for j in $(git grep -l $i); do sed "s@$i@$f@g" -i $j done fi done Thanks, Mauro