From: "Todd C. Miller" <Todd.Miller@sudo.ws>
Subject: Re: install symbolic links in the work tree
To: Stefan Sperling <stsp@stsp.name>
Cc: Tracey Emery <tracey@traceyemery.net>, gameoftrees@openbsd.org
Date: Thu, 23 Jul 2020 10:29:59 -0600

On Thu, 23 Jul 2020 17:04:03 +0200, Stefan Sperling wrote:

> I propose to rewrite the entire paragraph in more detail to hopefully
> make the intended meaning clear. What do you think?

Definitely better, I just have some small comments inline to add
commas and tweak the wording slightly.

 - todd

> diff 41806587196ab5f410de18aee2567cac7deb5d6b /home/stsp/src/got
> blob - 1bd20230e857c83cb4e2cbd62cec36b1a83b09ab
> file + got/got.1
> --- got/got.1
> +++ got/got.1
> @@ -1228,14 +1228,20 @@ option,
>  .Cm got commit
>  opens a temporary file in an editor where a log message can be written.
>  .It Fl S
> -Allow symbolic links which point somewhere outside of the path space
> -managed by
> -.Nm .
> +Allow the addition of symbolic links which point outside of the path space
> +that is under version control.
> +By default,
> +.Cm got commit
> +will reject such symbolic links due to safety concerns.
>  As a precaution,
> -when such a symbolic link gets installed in a work tree
>  .Nm
> -may decide to represent the symbolic link as a regular file which contains
> -the link's target path, rather than creating an actual symbolic link.
> +may decide to represent such a symbolic link as a regular file which contain
> s
> +the link's target path, rather than creating an actual symbolic link which
> +points outside of the work tree.
> +Use of this option is discouraged because external mechanisms such as
                                                               ^,

> +.Dq make obj
                ^,

> +are suited better for managing symbolic links to paths that are not under
      ^better suited                              remove "that are"

> +version control.
>  .El
>  .Pp
>  .Cm got commit
> @@ -1723,14 +1729,20 @@ responses line-by-line from the specified
>  .Ar response-script
>  file instead of prompting interactively.
>  .It Fl S
> -Allow symbolic links which point somewhere outside of the path space
> -managed by
> -.Nm .
> +Allow staging of symbolic links which point outside of the path space
> +that is under version control.
> +By default,
> +.Cm got stage
> +will reject such symbolic links due to safety concerns.
>  As a precaution,
> -when such a symbolic link gets installed in a work tree
>  .Nm
> -may decide to represent the symbolic link as a regular file which contains
> -the link's target path, rather than creating an actual symbolic link.
> +may decide to represent such a symbolic link as a regular file which contain
> s
> +the link's target path, rather than creating an actual symbolic link which
> +points outside of the work tree.
> +Use of this option is discouraged because external mechanisms such as
                                                                ^,
> +.Dq make obj
               ^,

> +are suited better for managing symbolic links to paths that are not under
      ^better suited                                    remove "that are"

> +version control.
>  .El
>  .Pp
>  .Cm got stage