Re: [PATCH] doc: remove "directory cache" from man pages

From: Utku <ugultopu@gmail.com>
Date: Jan 8, 2021, 19:51 UTC
Message-ID: <EB7BB287-A18B-45FE-B147-F3CF92FE3114@gmail.com>
In-Reply-To: <X/ilPZ71woYI5vT+@nand.local>

Hi Taylor,

I left that one on purpose. I initially thought that "Documentation/user-manual.txt" was just an outdated, "dead" file that wasn't being updated anymore and Pro Git 2 was the de-facto user manual now. Hence, I left it there so that it would provide historical context.

However, after having a look at the history of it, I realize that it is not a dead file at all. Also a web search for "git user manual" returns it as the first result, so I understand that it is still very much relevant.

On the other hand, the document clearly states that the terms "directory cache" and "cache" have been obsoleted by "index", so there is no source of confusion there. On the man pages, there was, which was the reason I felt the need to make this change. I thought that keeping at least one definition of "directory cache" (where this definition clearly states that it is an obsolete term for "index") would be helpful.

So what are your thoughts about it? If you think it is better to remove it, please let me know and I will remove it.

Best

Show 22 quoted lines

> On Jan 8, 2021, at 1:32 PM, Taylor Blau <me@ttaylorr.com> wrote:
> 
> Hi Utku,
> 
> On Fri, Jan 08, 2021 at 04:54:56PM +0000, Utku Gultopu via GitGitGadget wrote:
>> From: Utku Gultopu <ugultopu@gmail.com>
>> 
>> "directory cache" (or "directory cache index", "cache") are obsolete
>> terms which have been superseded by "index". Keeping them in the
>> documentation may be a source of confusion. This commit replaces
>> them with the current term, "index", on man pages.
> 
> This patch looks good to me. There is another mention of the old-style
> "directory cache" in the user manual (Documentation/user-manual.txt)
> which could probably be removed:
> 
>    Note that in older documentation you may see the index called the
>    "current directory cache" or just the "cache".  It has three important
>    properties:
> 
> Thanks,
> Taylor