Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S935195AbcKOWmT (ORCPT ); Tue, 15 Nov 2016 17:42:19 -0500 Received: from mail-pg0-f46.google.com ([74.125.83.46]:33452 "EHLO mail-pg0-f46.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S934338AbcKOWmR (ORCPT ); Tue, 15 Nov 2016 17:42:17 -0500 Date: Tue, 15 Nov 2016 14:42:14 -0800 From: Brian Norris To: Nicholas Mc Guire , Jonathan Corbet Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH] docs/completion.txt: drop dangling reference to completions-design.txt Message-ID: <20161115224214.GA106437@google.com> References: <20161025195000.GA17604@localhost> <20161026101126.GA1223@osadl.at> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20161026101126.GA1223@osadl.at> User-Agent: Mutt/1.5.21 (2010-09-15) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 2061 Lines: 48 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 --- 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