From: Brian Norris <briannorris@chromium.org>
To: Nicholas Mc Guire <der.herr@hofr.at>, Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH] docs/completion.txt: drop dangling reference to completions-design.txt
Date: Tue, 15 Nov 2016 14:42:14 -0800 [thread overview]
Message-ID: <20161115224214.GA106437@google.com> (raw)
In-Reply-To: <20161026101126.GA1223@osadl.at>
Per the original author, the proposed document was never deemed
necessary, and the important bits got merged into completion.txt. Let's
just stop confusing readers by pointing at a nonexistent doc.
Signed-off-by: Brian Norris <briannorris@chromium.org>
---
On Wed, Oct 26, 2016 at 10:11:26AM +0000, Nicholas Mc Guire wrote:
> On Tue, Oct 25, 2016 at 12:50:01PM -0700, Brian Norris wrote:
> > References in the introduced completion.txt doc have pointed lost souls
> > at an elusive completion-design.txt:
> >
> > "for details on completion design and implementation see
> > completions-design.txt"
[...]
> If I remember correctly it was Jonathan Corbet that suggested to merge the
> two and atleast the usage part got merged in the current completion.txt
> The path descriptions were not included as it was not clear how long such
> a path documentation would actually hold - so that was deliberately dropped
> The design goals/rational was more or less lost or not seen as relevant here
> as were the references/history and RT notes. As far as I remember it was a
> deliberate decision to drop these parts as they were not seen to be necessary.
>
> Those missing bits could be merged into the current completion.txt I do not
> think it makes much sense to have it in a seperate file.
I'm not super interested in the missing bits -- just in de-obfuscating
the doc. How about this?
Documentation/scheduler/completion.txt | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/Documentation/scheduler/completion.txt b/Documentation/scheduler/completion.txt
index 2622bc7a188b..656cf803c006 100644
--- a/Documentation/scheduler/completion.txt
+++ b/Documentation/scheduler/completion.txt
@@ -25,8 +25,7 @@ struct completion that tells the waiting threads of execution if they
can continue safely.
As completions are scheduling related, the code is found in
-kernel/sched/completion.c - for details on completion design and
-implementation see completions-design.txt
+kernel/sched/completion.c.
Usage:
--
2.8.0.rc3.226.g39d4020
next prev parent reply other threads:[~2016-11-15 22:42 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-25 19:50 [DOC] Missing completions-design.txt? Brian Norris
2016-10-26 10:11 ` Nicholas Mc Guire
2016-11-15 22:42 ` Brian Norris [this message]
2016-11-16 23:28 ` [PATCH] docs/completion.txt: drop dangling reference to completions-design.txt Jonathan Corbet
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=20161115224214.GA106437@google.com \
--to=briannorris@chromium.org \
--cc=corbet@lwn.net \
--cc=der.herr@hofr.at \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.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
Powered by JetHome