Commit af358f55386cfa2314813941ea81d531795792b0
2020-07-23T16:49:58
tweak description of new -S option for 'got commit' and 'got stage' with input from + ok tracy and millert
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
diff --git a/got/got.1 b/got/got.1
index 1bd2023..d0a000b 100644
--- a/got/got.1
+++ b/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 contains
+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 better suited for managing symbolic links to paths not under
+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 contains
+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 better suited for managing symbolic links to paths not under
+version control.
.El
.Pp
.Cm got stage