linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Martin Kepplinger <martink@posteo.de>
To: Jonathan Corbet <corbet@lwn.net>
Cc: mchehab@kernel.org, akpm@linux-foundation.org,
	torvalds@linux-foundation.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] README: Find more sane first words we have to say about Linux
Date: Mon, 1 May 2017 18:01:02 +0200	[thread overview]
Message-ID: <ffdfd6ad-6314-adaa-7763-bd9eda1e0dfb@posteo.de> (raw)
In-Reply-To: <20170501092440.58c28368@lwn.net>

Am 2017-05-01 um 17:24 schrieb Jonathan Corbet:
> On Sun, 30 Apr 2017 22:11:35 +0200
> Martin Kepplinger <martink@posteo.de> wrote:
> 
>> Imagine you're completely new to Linux, just real quick, ok? What do you do?
>> Wouldn't having a look at README be under first if no *the* first thing?
>> Ah there it is: README. "Linux kernel". nice! So what's that?
>> "This file was moved to ...... Please notice that there are several....".
>> Wtf!? Why? Can't they just tell me what's going on like a normal person?
> 
> So I don't doubt we could put something better there, but can we think for
> a moment about who the audience is here?  If you're "completely new to
> Linux", will you really start by jumping into the kernel source tree?
> Somehow I'm not quite convinced...  It seems to me that the README file
> should be aimed at developers who know what the kernel is but are not yet
> familiar with the process of configuring and building it.
> 

It should definitely be aimed at developers. But even as a developer who
is completely new to kernel development, it's nice to have some broad
context in 2 or 3 lines first.

(again, I'm a little exaggerating and) trying to see from an outside
point of view:
What other "official brief definition" of what Linux is could there be?
Right now one has the impression that the Linux Foundation has
"official" information, but that's (very strictly speaking) pretty
random right? Besides developers, I can imagine technical literature to
have a look at projects' README files for that.

I mean there *is* the new README.rst which is awesome. But it wouldn't
hurt to summarize the first few things in the README and then refer to
the doc. It should be something for people who

* already checked out the source obviously (developers, but or technical
authors, or any interested engineer), and

* who would *maybe* say, "what? nothing in the README? ok. I'll take
some definition I found online then" and not bother reading the
Documentation directory just yet.

                      martin

      reply	other threads:[~2017-05-01 16:01 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-04-30 20:11 [PATCH] README: Find more sane first words we have to say about Linux Martin Kepplinger
2017-05-01 15:24 ` Jonathan Corbet
2017-05-01 16:01   ` Martin Kepplinger [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=ffdfd6ad-6314-adaa-7763-bd9eda1e0dfb@posteo.de \
    --to=martink@posteo.de \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=torvalds@linux-foundation.org \
    /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 NNTP newsgroup(s).