Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1508589 > unrolled thread

[DOC] Missing completions-design.txt?

Back to article view | Back to linux.kernel

Contents

  [DOC] Missing completions-design.txt? Brian Norris <briannorris@chromium.org> - 2016-10-25 22:00 +0200
    Re: [DOC] Missing completions-design.txt? Nicholas Mc Guire <der.herr@hofr.at> - 2016-10-26 12:20 +0200

#1508589 — [DOC] Missing completions-design.txt?

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?

Thanks,
Brian

P.S. I haven't actually read the design doc that closely yet. Who would
trust such a random patch off the archives, after all? So just removing
the mention of this file might be a satisfactory solution.

[toc] | [next] | [standalone]

#1509027

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

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web