From: Eric Sunshine <sunshine@sunshineco.com>
To: git@vger.kernel.org
Cc: Jeff King <peff@peff.net>, Eric Sunshine <sunshine@sunshineco.com>
Subject: [PATCH 2/3] doc-diff: add --clean mode to remove temporary working gunk
Date: Fri, 31 Aug 2018 02:33:17 -0400 [thread overview]
Message-ID: <20180831063318.33373-3-sunshine@sunshineco.com> (raw)
In-Reply-To: <20180831063318.33373-1-sunshine@sunshineco.com>
As part of its operation, doc-diff creates a bunch of temporary
working files and holds onto them in order to speed up subsequent
invocations. These files are never deleted. Moreover, it creates a
temporary working tree (via git-wortkree) which likewise never gets
removed.
Without knowing the implementation details of the tool, a user may not
know how to clean up manually afterward. Worse, the user may find it
surprising and alarming to discover a working tree which s/he did not
create explicitly.
To address these issues, add a --clean mode which removes the
temporary working tree and deletes all generated files.
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
Documentation/doc-diff | 19 ++++++++++++++++---
1 file changed, 16 insertions(+), 3 deletions(-)
diff --git a/Documentation/doc-diff b/Documentation/doc-diff
index c2906eac5e..f397fd229b 100755
--- a/Documentation/doc-diff
+++ b/Documentation/doc-diff
@@ -2,20 +2,25 @@
OPTIONS_SPEC="\
doc-diff [options] <from> <to> [-- <diff-options>]
+doc-diff (-c|--clean)
--
j=n parallel argument to pass to make
f force rebuild; do not rely on cached results
+c,clean cleanup temporary working files
"
SUBDIRECTORY_OK=1
. "$(git --exec-path)/git-sh-setup"
parallel=
force=
+clean=
while test $# -gt 0
do
case "$1" in
-j)
parallel=$2; shift ;;
+ -c|--clean)
+ clean=t ;;
-f)
force=t ;;
--)
@@ -26,6 +31,17 @@ do
shift
done
+cd_to_toplevel
+tmp=Documentation/tmp-doc-diff
+
+if test -n "$clean"
+then
+ test $# -eq 0 || usage
+ git worktree remove --force "$tmp/worktree" 2>/dev/null
+ rm -rf "$tmp"
+ exit 0
+fi
+
if test -z "$parallel"
then
parallel=$(getconf _NPROCESSORS_ONLN 2>/dev/null)
@@ -42,9 +58,6 @@ to=$1; shift
from_oid=$(git rev-parse --verify "$from") || exit 1
to_oid=$(git rev-parse --verify "$to") || exit 1
-cd_to_toplevel
-tmp=Documentation/tmp-doc-diff
-
if test -n "$force"
then
rm -rf "$tmp"
--
2.19.0.rc1.352.gb1634b371d
next prev parent reply other threads:[~2018-08-31 6:33 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-08-30 8:12 [PATCH] doc-diff: always use oids inside worktree Jeff King
2018-08-30 9:12 ` Eric Sunshine
2018-08-30 19:55 ` [PATCH] doc/Makefile: remove tmp-doc-diff on "make clean" Jeff King
2018-08-30 20:34 ` Eric Sunshine
2018-08-30 20:36 ` Eric Sunshine
2018-08-30 20:52 ` Jeff King
2018-08-31 6:33 ` [PATCH 0/3] doc-diff: add "clean" mode & fix portability problem Eric Sunshine
2018-08-31 6:33 ` [PATCH 1/3] doc-diff: fix non-portable 'man' invocation Eric Sunshine
2018-08-31 19:49 ` Jeff King
2018-08-31 6:33 ` Eric Sunshine [this message]
2018-08-31 20:01 ` [PATCH 2/3] doc-diff: add --clean mode to remove temporary working gunk Jeff King
2018-08-31 21:24 ` Eric Sunshine
2018-08-31 6:33 ` [PATCH 3/3] doc/Makefile: drop doc-diff worktree and temporary files on "make clean" Eric Sunshine
2018-08-31 20:07 ` Jeff King
2018-08-31 21:37 ` Eric Sunshine
2018-09-17 18:32 ` Jonathan Nieder
2018-09-17 19:36 ` Junio C Hamano
2018-09-17 19:42 ` Jonathan Nieder
2018-09-17 19:48 ` Junio C Hamano
2018-09-17 19:55 ` Jonathan Nieder
2018-09-18 17:38 ` Jeff King
2018-09-17 20:43 ` Eric Sunshine
2018-09-17 20:52 ` Eric Sunshine
2018-08-31 18:49 ` [PATCH 0/3] doc-diff: add "clean" mode & fix portability problem Junio C Hamano
2018-08-31 20:08 ` Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180831063318.33373-3-sunshine@sunshineco.com \
--to=sunshine@sunshineco.com \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).