Re: [PATCH 12/12] fsmonitor: update doc for Linux

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sun, Oct 09 2022, Eric DeCosta via GitGitGadget wrote:

> From: Eric DeCosta <edecosta@xxxxxxxxxxxxx>
>
> Update the documentation for Linux.
>
> Signed-off-by: Eric DeCosta <edecosta@xxxxxxxxxxxxx>
> ---
>  Documentation/config/fsmonitor--daemon.txt |  4 ++--
>  Documentation/git-fsmonitor--daemon.txt    | 24 ++++++++++++++--------
>  2 files changed, 18 insertions(+), 10 deletions(-)
>
> diff --git a/Documentation/config/fsmonitor--daemon.txt b/Documentation/config/fsmonitor--daemon.txt
> index c225c6c9e74..2cafb040d96 100644
> --- a/Documentation/config/fsmonitor--daemon.txt
> +++ b/Documentation/config/fsmonitor--daemon.txt
> @@ -4,8 +4,8 @@ fsmonitor.allowRemote::
>      behavior.  Only respected when `core.fsmonitor` is set to `true`.
>  
>  fsmonitor.socketDir::
> -    This Mac OS-specific option, if set, specifies the directory in
> +    Mac OS and Linux-specific option. If set, specifies the directory in
>      which to create the Unix domain socket used for communication
>      between the fsmonitor daemon and various Git commands. The directory must
> -    reside on a native Mac OS filesystem.  Only respected when `core.fsmonitor`
> +    reside on a native filesystem.  Only respected when `core.fsmonitor`
>      is set to `true`.

I think this should be squashed into the relevant commit(s) when we
start supporting this fsmonitor.socketDir for that platform.

But on the content: Shouldn't we just reword this to say something like
"*nix"-specific, we only have one platform which is likely to not have
"sockets", i.e. Windows, no?

So rather than having an ever growing list of OS's that'll inevitably
grow to something like:

	Mac OS, Linux, FreeBSD, NetBSD, OpenBSD, GNU/Hurd-specific
	option, if set...

Let's find some way to refer to the platforms we do support, and instead
mention the only one we don't support sockets on?

> diff --git a/Documentation/git-fsmonitor--daemon.txt b/Documentation/git-fsmonitor--daemon.txt
> index 8238eadb0e1..c2b08229c74 100644
> --- a/Documentation/git-fsmonitor--daemon.txt
> +++ b/Documentation/git-fsmonitor--daemon.txt
> @@ -76,23 +76,31 @@ repositories; this may be overridden by setting `fsmonitor.allowRemote` to
>  correctly with all network-mounted repositories and such use is considered
>  experimental.
>  
> -On Mac OS, the inter-process communication (IPC) between various Git
> +On Linux and Mac OS, the inter-process communication (IPC) between various Git

Ditto.




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux