mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Daniel Vetter <daniel@ffwll.ch>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Joe Perches <joe@perches.com>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs: Make CodingStyle and SubmittingPatches symlinks
Date: Fri, 24 Feb 2017 08:50:02 +0100	[thread overview]
Message-ID: <20170224075002.wfjmlsv7bokrlmk6@phenom.ffwll.local> (raw)
In-Reply-To: <20170214143438.668a7c5b@lwn.net>

On Tue, Feb 14, 2017 at 02:34:38PM -0700, Jonathan Corbet wrote:
> On Mon, 23 Jan 2017 08:34:58 -0200
> Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
> 
> > The main difference between a "pointer file" and a symlink is that the
> > first indicates a temporary solution, teaching people that the
> > file got renamed and were it is located now. As such, we can remove
> > those "pointer files" on some future Kernel releases without much concern.
> > 
> > A symlink indicates a more permanent situation, as people will keep
> > using the symlinked files as before. That means that any attempt to
> > remove those in the future will generate concerns.
> > 
> > So, I'm in favor of using the "pointer files" instead, as it
> > gives us an easier way to get rid of them when we find convenient.
> 
> So you've all long since forgotten this discussion, I'm sure, but I've
> been pondering it on and off for quite a while.
> 
> The movement of some of the more well-known documents has been a concern
> of mine from the beginning; that is why I delayed those changes for
> a cycle and raised the issue at a number of conferences, culminating in
> the kernel summit in November.  I got a strong sense of consensus that we
> should go ahead and move the files.
> 
> As Mauro says, symlinks are forever; they say we'll never really succeed
> in rationalizing the structure of Documentation/.  But we don't nail down
> the location of any other files in the kernel source tree in this manner,
> and my own feeling is that we shouldn't do that here either.  The kernel
> source tree is not an API.  So my thinking at the moment is that we should
> retain the current "pointer files" in the vague hope that, someday, we
> won't need them anymore.

It's a tricky balance, but I think your stance is reasonable and seems to
reflect overall consensus (which might chance, we'll see).

+1 from my side.

Thanks, Daniel
-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

      parent reply	other threads:[~2017-02-24  7:50 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-01-10 22:09 Joe Perches
2017-01-11  8:54 ` Jani Nikula
2017-01-11  9:31   ` Joe Perches
2017-01-11  9:45     ` Jani Nikula
2017-01-13 19:41 ` Jonathan Corbet
2017-01-13 20:03   ` Joe Perches
2017-01-23 10:34     ` Mauro Carvalho Chehab
2017-01-23 10:44       ` Geert Uytterhoeven
2017-01-23 10:54         ` Joe Perches
2017-01-23 13:01         ` Mauro Carvalho Chehab
2017-01-23 13:25           ` Geert Uytterhoeven
2017-02-14 21:34       ` Jonathan Corbet
2017-02-14 21:37         ` Joe Perches
2017-02-24  7:50         ` Daniel Vetter [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170224075002.wfjmlsv7bokrlmk6@phenom.ffwll.local \
    --to=daniel@ffwll.ch \
    --cc=corbet@lwn.net \
    --cc=joe@perches.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@s-opensource.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®