clarify wording in got.1 related to local changes/commits/branches
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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
diff --git a/got/got.1 b/got/got.1
index b84282b..b6a8a54 100644
--- a/got/got.1
+++ b/got/got.1
@@ -234,8 +234,7 @@ Cannot be used together with any of the other options except
.It Fl m
Create the cloned repository as a mirror of the original repository.
This is useful if the cloned repository will not be used to store
-local changes as created by
-.Cm got commit .
+locally created commits.
.Pp
The repository's
.Pa config
@@ -245,7 +244,7 @@ option enabled, such that
.Cm got fetch
or
.Xr git-fetch 1
-will write incoming changes directly to local branches in the
+will write incoming changes directly to branches in the
.Dq refs/heads/
reference namespace, rather than to branches in the
.Dq refs/remotes/
@@ -254,9 +253,11 @@ This avoids the usual requirement of having to run
.Cm got rebase
after
.Cm got fetch
-in order to make incoming changes appear on local branches.
-But maintaining local changes in the cloned repository becomes difficult
-since local changes will be at risk of being discarded whenever incoming
+in order to make incoming changes appear on branches in the
+.Dq refs/heads/
+namespace.
+But maintaining custom changes in the cloned repository becomes difficult
+since such changes will be at risk of being discarded whenever incoming
changes are fetched.
.It Fl q
Suppress progress reporting output.
@@ -325,9 +326,10 @@ By default, branch references in the
reference namespace will be updated to point at the newly fetched commits.
The
.Cm got rebase
-command can then be used to make new changes visible on local branches in the
+command can then be used to make new changes visible on branches in the
.Dq refs/heads/
-namespace, merging incoming changes with local changes as necessary.
+namespace, merging incoming changes with the changes on those branches
+as necessary.
.Pp
If the repository was created as a mirror with
.Cm got clone -m
@@ -338,7 +340,7 @@ the remote repository.
If those branches contained local commits, these commits will no longer be
reachable via a reference and will therefore be at risk of being discarded
by Git's garbage collector.
-Maintaining local changes in a mirror repository is therefore discouraged.
+Maintaining custom changes in a mirror repository is therefore discouraged.
.Pp
In any case, references in the
.Dq refs/tags/
@@ -433,8 +435,7 @@ in which case references will be mapped directly into the local repository's
.Dq refs/
namespace.
.Pp
-Once a reference has been fetched, a local branch based on it can be
-created with
+Once a reference has been fetched, a branch based on it can be created with
.Cm got branch
if needed.
.Pp
@@ -754,7 +755,7 @@ is never traversed.
.El
.It Cm diff Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Oo Fl w Oc Op Ar object1 Ar object2 | Ar path
When invoked within a work tree with less than two arguments, display
-uncommitted changes in the work tree.
+local changes in the work tree.
If a
.Ar path
is specified, only show changes within this path.
@@ -783,7 +784,7 @@ work tree, use the repository path associated with this work tree.
.It Fl s
Show changes staged with
.Cm got stage
-instead of showing local changes.
+instead of showing local changes in the work tree.
This option is only valid when
.Cm got diff
is invoked in a work tree.
@@ -1087,7 +1088,7 @@ The options for
are as follows:
.Bl -tag -width Ds
.It Fl f
-Perform the operation even if a file contains uncommitted modifications.
+Perform the operation even if a file contains local modifications.
.It Fl k
Keep affected files on disk.
.It Fl R
@@ -1102,7 +1103,7 @@ is a directory.
Short alias for
.Cm remove .
.It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
-Revert any uncommitted changes in files at the specified paths.
+Revert any local changes in files at the specified paths in a work tree.
File contents will be overwritten with those contained in the
work tree's base commit.
There is no way to bring discarded changes back after