From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751597AbcFVGBB (ORCPT ); Wed, 22 Jun 2016 02:01:01 -0400 Received: from mail2-relais-roc.national.inria.fr ([192.134.164.83]:21290 "EHLO mail2-relais-roc.national.inria.fr" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750967AbcFVGBA (ORCPT ); Wed, 22 Jun 2016 02:01:00 -0400 X-IronPort-AV: E=Sophos;i="5.26,508,1459807200"; d="scan'208";a="223388028" Date: Wed, 22 Jun 2016 07:56:29 +0200 (CEST) From: Julia Lawall X-X-Sender: jll@localhost6.localdomain6 To: "Luis R. Rodriguez" cc: Julia Lawall , "Nicolas Palix (LIG)" , Gilles.Muller@lip6.fr, mmarek@suse.com, linux-kernel@vger.kernel.org, akpm@linux-foundation.org, gregkh@linuxfoundation.org, markivx@codeaurora.org, stephen.boyd@linaro.org, zohar@linux.vnet.ibm.com, broonie@kernel.org, ming.lei@canonical.com, tiwai@suse.de, johannes@sipsolutions.net, chunkeey@googlemail.com, hauke@hauke-m.de, jwboyer@fedoraproject.org, dmitry.torokhov@gmail.com, dwmw2@infradead.org, jslaby@suse.com, torvalds@linux-foundation.org, deepa.kernel@gmail.com, cocci@systeme.lip6.fr Subject: Re: [PATCH v3 7/8] coccicheck: refer to coccicheck bottest wiki for documentation In-Reply-To: <20160622000730.GL25646@wotan.suse.de> Message-ID: References: <1466536893-23355-1-git-send-email-mcgrof@kernel.org> <1466536893-23355-8-git-send-email-mcgrof@kernel.org> <9db10e04-779a-1bae-0ffe-2d43e5f46d2e@imag.fr> <20160622000730.GL25646@wotan.suse.de> User-Agent: Alpine 2.02 (DEB 1266 2009-07-14) MIME-Version: 1.0 Content-Type: MULTIPART/MIXED; BOUNDARY="8323328-1107042166-1466574990=:2082" Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This message is in MIME format. The first part should be readable text, while the remaining parts are likely unreadable without MIME-aware tools. --8323328-1107042166-1466574990=:2082 Content-Type: TEXT/PLAIN; charset=iso-8859-1 Content-Transfer-Encoding: 8BIT On Wed, 22 Jun 2016, Luis R. Rodriguez wrote: > On Tue, Jun 21, 2016 at 11:18:41PM +0200, Julia Lawall wrote: > > > > > > On Tue, 21 Jun 2016, Nicolas Palix (LIG) wrote: > > > > > Hi, > > > > > > Le 21/06/16 à 21:21, Luis R. Rodriguez a écrit : > > > > Sprinkling *tons* of documentation on the script is not a good > > > > idea, instead refer to a wiki for further coccicheck documentation: > > > > > > > > https://bottest.wiki.kernel.org/coccicheck > > > > > > > > This page shall always refer to the linux-next iteration of > > > > scripts/coccicheck. > > > > > > Can you say a word about Documentation/coccinelle.txt too ? > > > And update it according to the script changes. > > > > I think this would be a good idea. > > I'd much prefer to just keep docs in a wiki, and we nuke this outdated doc or > refer in the Documentation/coccinelle.txt to the wiki. This lets us document > things much faster and lets us add more information in a much nicer format. But > that's just me... External links have a surprising way of disappearing. They also require internet access. julia > The existing file Documentation/coccinelle.txt even provides documentation on > how to build coccinelle --we're way passed that point. Note, I havne't > updated the docs on the wiki to refer to any of this, and would not unless > these changes get merged at least to linux-next. > > Luis > --8323328-1107042166-1466574990=:2082--