Subject: Re: [PATCH v2 10/20] pathspec: move doc to pathspec.h

From: Emily Shaffer <[email-masked]>
Date: Wed, 6 Nov 2019 17:26:33 -0800

On Wed, Nov 06, 2019 at 09:59:37AM +0000, Heba Waly via GitGitGadget wrote:
> From: Heba Waly <[email-masked]>
> 
> Move the documentation from Documentation/technical/api-setup.txt
> to pathspec.h as it's easier for the developers to find the usage
> information beside the code instead of looking for it in another doc file.
> 
> Also documentation/technical/api-setup.txt is removed because the
> information it has is now redundant and it'll be hard to keep it up to
> date and synchronized with the documentation in the header file.
> 
> Signed-off-by: Heba Waly <[email-masked]>
> ---
>  Documentation/technical/api-setup.txt | 47 ---------------------------
>  pathspec.h                            | 34 ++++++++++++++++++-
>  2 files changed, 33 insertions(+), 48 deletions(-)
>  delete mode 100644 Documentation/technical/api-setup.txt
> 
> diff --git a/Documentation/technical/api-setup.txt b/Documentation/technical/api-setup.txt
> deleted file mode 100644
> index eb1fa9853e..0000000000
> --- a/Documentation/technical/api-setup.txt
> +++ /dev/null
> @@ -1,47 +0,0 @@
> -setup API
> -=========
> -
> -Talk about
> -
> -* setup_git_directory()
> -* setup_git_directory_gently()
> -* is_inside_git_dir()
> -* is_inside_work_tree()
> -* setup_work_tree()
> -
> -(Dscho)
> -
> -Pathspec
> ---------
> -
> -See glossary-context.txt for the syntax of pathspec. In memory, a
I kind of miss this pointer after the change. But, maybe other folks in
the project prefer to let someone grep for this themselves.

Otherwise it looks fine to me. Thanks.

 - Emily