Documentation lingering inconsistency between working directory and working tree
From: Yazeed Sabri <hidden>
Date: 2017-07-17 19:34:48
Subsystem:
the rest · Maintainer:
Linus Torvalds
Hi all,
I have been reading the git documentation for a while now and came to
realize that in a
lot of commands the documentation is ambiguous when it comes to the difference
between "working directory" and "working tree". I'm aware of the
changes to status
in this commit for example:
commit 2a0e6cdedab306eccbd297c051035c13d0266343
Author: Lars Vogel [off-list ref]
Date: Thu Jun 9 20:19:30 2016 +0200
Use "working tree" instead of "working directory" for git status
Working directory can be easily confused with the current directory.
In one of my patches I already updated the usage of working
directory
with working tree for the man page but I noticed that git status
also
uses this incorrect term.
Signed-off-by: Lars Vogel [off-list ref]
Signed-off-by: Junio C Hamano [off-list ref]
diff --git a/wt-status.c b/wt-status.c
index 4f27bd62a..4ce4e35ac 100644
--- a/wt-status.c
+++ b/wt-status.c@@ -1554,7 +1554,7 @@ void wt_status_print(struct wt_status *s) else printf(_("nothing to commit\n")); } else - printf(_("nothing to commit, working directory
clean\n"));
+ printf(_("nothing to commit, working tree
clean\n"));
}
}
and more frequently used commands like add are consistent as well. But a
grep on the documentation to a pull I did today, shows that a lot of
commands are still
not updated accordingly.
This brings me to my next point, so what is the precise definition of
each concept? Is
working directory just an outdated mistake?
Was the change in status above made to solve the confusion and denote
that status
is unique per-working tree given its HEAD? If this is the case, then
is gc unique
per-working tree too, or is it done on the "database" like fsck? Same
idea with stash,
does stash care on what working tree it was called? If not, does it
make sense for
it to do so?
Best,
Yazeed
--
------------------------------
This message and its contents, including attachments are intended solely
for the original recipient. If you are not the intended recipient or have
received this message in error, please notify me immediately and delete
this message from your computer system. Any unauthorized use or
distribution is prohibited. Please consider the environment before printing
this email.