From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Return-Path: Date: Wed, 9 May 2018 23:27:28 +0200 From: Andrea Parri To: Mauro Carvalho Chehab Cc: Alan Stern , Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Dmitry Torokhov , Rob Herring , Mark Rutland , Linus Walleij , Ananth N Mavinakayanahalli , Anil S Keshavamurthy , "David S. Miller" , Masami Hiramatsu , Mathieu Poirier , Alexander Shishkin , Harry Wei , Russell King , Catalin Marinas , Will Deacon , Michal Simek , Jeff Dike , Richard Weinberger , Guan Xuetao , Thomas Gleixner , Ingo Molnar , "H. Peter Anvin" , x86@kernel.org, Chris Zankel , Max Filippov , Jens Axboe , David Howells , David Woodhouse , Herbert Xu , Arnd Bergmann , Greg Kroah-Hartman , Michael Turquette , Stephen Boyd , David Airlie , Gustavo Padovan , Maarten Lankhorst , Sean Paul , Pali =?iso-8859-1?Q?Roh=E1r?= , Matias Bjorling , Michael Lyle , Kent Overstreet , Malcolm Priestley , Antoine Jacquet , Sudip Mukherjee , Steven Rostedt , "Paul E. McKenney" , Josh Triplett , Mathieu Desnoyers , Lai Jiangshan , Boris Ostrovsky , Juergen Gross , Li Zefan , Paul Moore , Stephen Smalley , Eric Paris , James Morris , "Serge E. Hallyn" , Jaroslav Kysela , Takashi Iwai , Peter Zijlstra , Boqun Feng , Nicholas Piggin , Jade Alglave , Luc Maranget , Akira Yokosawa , Arnaldo Carvalho de Melo , Jiri Olsa , Namhyung Kim , linux-input@vger.kernel.org, devicetree@vger.kernel.org, linux-gpio@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-kernel@zh-kernel.org, user-mode-linux-devel@lists.sourceforge.net, user-mode-linux-user@lists.sourceforge.net, linux-xtensa@linux-xtensa.org, linux-block@vger.kernel.org, keyrings@vger.kernel.org, linux-crypto@vger.kernel.org, linux-clk@vger.kernel.org, dri-devel@lists.freedesktop.org, patches@opensource.cirrus.com, linux-bcache@vger.kernel.org, linux-usb@vger.kernel.org, devel@driverdev.osuosl.org, xen-devel@lists.xenproject.org, cgroups@vger.kernel.org, selinux@tycho.nsa.gov, linux-security-module@vger.kernel.org, alsa-devel@alsa-project.org Subject: Re: [PATCH v2 09/11] docs: Fix some broken references Message-ID: <20180509212728.GA4178@andrea> References: <20180509152045.722f0c51@vento.lan> <20180509164153.5b9ab9db@vento.lan> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii In-Reply-To: <20180509164153.5b9ab9db@vento.lan> List-ID: On Wed, May 09, 2018 at 04:41:53PM -0300, Mauro Carvalho Chehab wrote: > Em Wed, 9 May 2018 15:11:07 -0400 (EDT) > Alan Stern escreveu: > > > On Wed, 9 May 2018, Mauro Carvalho Chehab wrote: > > > > > Em Wed, 9 May 2018 19:15:01 +0200 > > > Andrea Parri escreveu: > > > > > > > tools/memory-model/README | 10 +++++----- > > > > > > > > As mentioned in the previous thread, I am for keeping the current > > > > references: the REAMDE is listing the doc files, as well as other > > > > files in tools/memory-model/, relatively to that directory. > > > > > > Yeah, at least this hunk deserves some rework, as now some > > > references are Documentation/.../foo, while others are just > > > bar. > > > > > > As on (almost) all other places (except for tools/memory-model/README), > > > the references are always from the main directory, I would make all > > > patches there also relative to main dir. If you're afraid of > > > not being too clearer, we could prefix all of them with something > > > like: > > > > > > ${LINUX}/tools/memory-model/... > > > > > > just like some DT binding files do: > > > > > > Documentation/devicetree/bindings/sound/audio-graph-card.txt:see ${LINUX}/Documentation/devicetree/bindings/graph.txt > > > > > > A bonus of doing that is that the broken reference detect script can > > > keep parsing it without changes (well, it wouldn't be hard to make > > > it also accept a relative file, but doing that just due to > > > tools/memory-model/README seems overkill). > > > > > > Another advantage is that it would allow to easily add references > > > there from the main kernel Documentation, if needed in the future, > > > without messing with local x non-local relative namespace. > > > > How about changing the relative references so that something like > > Documentation/recipes.txt becomes ./Documentation/recipes.txt? > > Sounds a good idea to me. Andrea? Counterintuitive ;-) Documentation/abc.txt vs. ./Documentation/abc.txt But let me sleep over this ;-) for the time being, I renew my vote for "just don't commit these changes (and keep checking automated changes)". Andrea > > Thanks, > Mauro