Ksummit-Discuss Archive mirror
 help / color / mirror / Atom feed
From: Geert Uytterhoeven <geert@linux-m68k.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Jiri Kosina <jkosina@suse.cz>,
	ksummit-discuss@lists.linux-foundation.org
Subject: Re: [Ksummit-discuss] [MAINTAINERS SUMMIT] Documentation issues
Date: Wed, 28 Jun 2017 21:48:47 +0200	[thread overview]
Message-ID: <CAMuHMdWJLkJe=a0YiiypzZ728Sv=SK87-E2qXw5dBiz2zSfB-Q@mail.gmail.com> (raw)
In-Reply-To: <20170626161828.3914fcc1@lwn.net>

Hi Jon,

On Tue, Jun 27, 2017 at 12:18 AM, Jonathan Corbet <corbet@lwn.net> wrote:
> On Sun, 25 Jun 2017 22:56:07 +0200 (CEST)
> Jiri Kosina <jkosina@suse.cz> wrote:
>> Unfortunately option (3) has also been applied to some of the files:
>>
>>       $ ll Documentation/kernel-parameters.txt
>>       ls: cannot access 'Documentation/kernel-parameters.txt': No such file or directory
>>
>> I wasn't sure whether this was intentional or not. But if not, I'll
>> happily send a patch that introduces a symlink.
>
> Worries about moving well-known files are why I delayed some of this stuff
> a bit so I could bring it up at conferences and the kernel summit.  It
> only proceeded after I didn't get any real pushback in those settings.
>
> In general, we move files around in the kernel tree all the time.  We
> don't normally leave symlinks behind; indeed, we never do.  Instead, we
> figure out where the file moved to and get on with life.  Are
> documentation files somehow different, needing different rules in this
> regard?  I wouldn't mind some clarity on that point.

Documentation files are special in that they (some of them) are much more
likely to be linked from an external web page, and may be read by mere
mortals.

My gut feeling says this is mostly limited to SubmittingPatches and
CodingStyle, which are (coincidently?) the only two files in the top level
using CamelCase.

Source files are mostly used by developers, who don't rely on external links,
and who are used to work with the source file hierarchy on a regular basis.

Gr{oetje,eeting}s,

                        Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds

  parent reply	other threads:[~2017-06-28 19:48 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-06-23 18:39 [Ksummit-discuss] [MAINTAINERS SUMMIT] Documentation issues Jonathan Corbet
2017-06-23 23:09 ` Rafael J. Wysocki
2017-06-24 12:03   ` Rafael J. Wysocki
2017-06-24 10:46 ` Mauro Carvalho Chehab
2017-06-24 12:20   ` Rafael J. Wysocki
2017-06-24 13:41     ` Mauro Carvalho Chehab
2017-06-25 20:56       ` Jiri Kosina
2017-06-26  1:20         ` Mauro Carvalho Chehab
2017-06-26 21:18           ` Rafael J. Wysocki
2017-06-26  5:58         ` Takashi Iwai
2017-06-26 21:28           ` Rafael J. Wysocki
2017-06-27  8:41             ` Daniel Vetter
2017-06-27 10:31               ` Mauro Carvalho Chehab
2017-06-26 22:18         ` Jonathan Corbet
2017-06-27 18:42           ` Bird, Timothy
2017-06-28 19:48           ` Geert Uytterhoeven [this message]
     [not found]       ` <CAFhKne8ZttmqWYJToCw9EDywzeMdp=eiFpoZ+O5xrzmKnpA09Q@mail.gmail.com>
     [not found]         ` <CAFhKne_W-EbjUd_Cm4kyBHrVK6K9r8Ss3gY0ogO1nztbQZYBEg@mail.gmail.com>
2017-06-25 21:32           ` Matthew Wilcox
2017-06-25 21:42             ` Rafael J. Wysocki
2017-06-26  1:15               ` Mauro Carvalho Chehab
2017-06-26 21:16                 ` Rafael J. Wysocki
2017-06-26  0:58             ` Mauro Carvalho Chehab
2017-06-25 16:13     ` Jonathan Corbet
2017-06-26 12:19 ` Mark Brown
2017-06-27  8:38   ` Daniel Vetter
2017-06-27 15:33     ` Mark Brown

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='CAMuHMdWJLkJe=a0YiiypzZ728Sv=SK87-E2qXw5dBiz2zSfB-Q@mail.gmail.com' \
    --to=geert@linux-m68k.org \
    --cc=corbet@lwn.net \
    --cc=jkosina@suse.cz \
    --cc=ksummit-discuss@lists.linux-foundation.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).