[PATCH] RelNotes: fsmonitor: add a pointer to man page and the word itself

[PATCH] RelNotes: fsmonitor: add a pointer to man page and the word itself

[Yasushi SHOJI]

Add a pointer to git-update-index(1) and a bit more detail about
fsmonitor and watchman to help people following up the new feature.
---

Hi Ben and Junio,

Wouldn't it be nice to tell the world a bit more about "file system
monitor" we now support?  I think that "git status" and "watchman"
might not ring the bell for some, but adding a word "file system
monitor" may.

I know most of repos don't need fsmonitor but it's a cool feature to
have it. ;-)

WDYT?


 Documentation/RelNotes/2.16.0.txt | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/Documentation/RelNotes/2.16.0.txt b/Documentation/RelNotes/2.16.0.txt
index 919f3eb3e..0c81c5915 100644
--- a/Documentation/RelNotes/2.16.0.txt
+++ b/Documentation/RelNotes/2.16.0.txt
@@ -62,8 +62,11 @@ UI, Workflows & Features
  * The SubmittingPatches document has been converted to produce an
    HTML version via AsciiDoc/Asciidoctor.

- * We learned to talk to watchman to speed up "git status" and other
-   operations that need to see which paths have been modified.
+ * We learned to optionally talk to a file system monitor via new
+   fsmonitor extension to speed up "git status" and other operations
+   that need to see which paths have been modified.  Currently we only
+   support "watchman".  See File System Monitor section of
+   git-update-index(1) for more detail.

  * The "diff" family of commands learned to ignore differences in
    carriage return at the end of line.
--
2.15.1

RE: [PATCH] RelNotes: fsmonitor: add a pointer to man page and the word itself

[Ben Peart]

> -----Original Message-----
> From: Yasushi SHOJI [mailto:yashi@atmark-techno.com]
> Sent: Wednesday, January 17, 2018 12:09 AM
> To: Ben Peart <Ben.Peart@microsoft.com>; gitster@pobox.com
> Cc: git@vger.kernel.org
> Subject: [PATCH] RelNotes: fsmonitor: add a pointer to man page and the
> word itself
> 
> Add a pointer to git-update-index(1) and a bit more detail about fsmonitor
> and watchman to help people following up the new feature.
> ---
> 
> Hi Ben and Junio,
> 
> Wouldn't it be nice to tell the world a bit more about "file system monitor"
> we now support?  I think that "git status" and "watchman"
> might not ring the bell for some, but adding a word "file system monitor"
> may.
> 

Thanks for the call out!  It would be great if everyone who has larger repos and experiencing slower command performance could learn about the new file system monitor support.  I'm not sure if editing the release notes would be enough to do that or not. 😊  It's important to note that the support for file system monitors in git is generic - any file system monitor can be integrated with the proper hook/script.  We just provided a Perl script to integrate with Watchman as a usable sample as Watchman is already available on several platforms.

> I know most of repos don't need fsmonitor but it's a cool feature to have it. ;-
> )
> 
> WDYT?
> 
> 
>  Documentation/RelNotes/2.16.0.txt | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/RelNotes/2.16.0.txt
> b/Documentation/RelNotes/2.16.0.txt
> index 919f3eb3e..0c81c5915 100644
> --- a/Documentation/RelNotes/2.16.0.txt
> +++ b/Documentation/RelNotes/2.16.0.txt
> @@ -62,8 +62,11 @@ UI, Workflows & Features
>   * The SubmittingPatches document has been converted to produce an
>     HTML version via AsciiDoc/Asciidoctor.
> 
> - * We learned to talk to watchman to speed up "git status" and other
> -   operations that need to see which paths have been modified.
> + * We learned to optionally talk to a file system monitor via new
> +   fsmonitor extension to speed up "git status" and other operations
> +   that need to see which paths have been modified.  Currently we only
> +   support "watchman".  See File System Monitor section of
> +   git-update-index(1) for more detail.
> 
>   * The "diff" family of commands learned to ignore differences in
>     carriage return at the end of line.
> --
> 2.15.1

Re: [PATCH] RelNotes: fsmonitor: add a pointer to man page and the word itself

[Junio C Hamano]

Ben Peart <Ben.Peart@microsoft.com> writes:

> It's important to note that the support for file system monitors
> in git is generic - any file system monitor can be integrated with
> the proper hook/script.  We just provided a Perl script to
> integrate with Watchman as a usable sample as Watchman is already
> available on several platforms.

Mentioning only "FS monitor" is insufficient (it would merely
frustrate those with FS monitor that is not watchman, after they
waste more time to find out that we only do watchman right now).
Mentioning only "Watchman" *is* sufficient, though.

Mentioning both would be ideal, i.e. e.g. "We now have a generic
mechanism to talk to FS monitors to optimize checks of working tree
files, and this version of Git can talk to Watchman using the
mechanism".  And that is what Yashi's suggestion did, if I am not
mistaken.