All of lore.kernel.org
 help / color / mirror / Atom feed
From: Nicholas Mc Guire <der.herr@hofr.at>
To: Brian Norris <briannorris@chromium.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [DOC] Missing completions-design.txt?
Date: Wed, 26 Oct 2016 10:11:26 +0000	[thread overview]
Message-ID: <20161026101126.GA1223@osadl.at> (raw)
In-Reply-To: <20161025195000.GA17604@localhost>

On Tue, Oct 25, 2016 at 12:50:01PM -0700, Brian Norris wrote:
> Hi,
> 
> It looks like Nicholas submitted this doc a while back as patch 2/2:
> 
> "[PATCH 2/2] doc: detailed documentation for completion"
> http://lkml.iu.edu/hypermail/linux/kernel/1412.2/03676.html
> 
> where patch 1/2 got merged as this:
> 
> 202799be447b doc: brief user documentation for completion
> 
> 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"
> 
> Since as we well know, most developers are religious readers of
> documentation, presumably there are people out there waiting expectantly
> for such a file to appear in their otherwise exhaustive Documentation/.
> Can you help such lost souls out?
>
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.

thx!
hofrat

  reply	other threads:[~2016-10-26 10:11 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 [this message]
2016-11-15 22:42   ` [PATCH] docs/completion.txt: drop dangling reference to completions-design.txt Brian Norris
2016-11-16 23:28     ` 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=20161026101126.GA1223@osadl.at \
    --to=der.herr@hofr.at \
    --cc=briannorris@chromium.org \
    --cc=corbet@lwn.net \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.