From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jiang Xin Subject: [PATCH v14 14/16] git-clean: add documentation for interactive git-clean Date: Mon, 24 Jun 2013 23:21:38 +0800 Message-ID: <28725b96320fbc26322860c7213fa20ae7b4863c.1372087065.git.worldhello.net@gmail.com> References: Cc: Git List , Jiang Xin To: Junio C Hamano , Johannes Sixt X-From: git-owner@vger.kernel.org Mon Jun 24 17:22:57 2013 Return-path: Envelope-to: gcvg-git-2@plane.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Ur8bY-0006sB-28 for gcvg-git-2@plane.gmane.org; Mon, 24 Jun 2013 17:22:56 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752055Ab3FXPWx (ORCPT ); Mon, 24 Jun 2013 11:22:53 -0400 Received: from mail-pa0-f44.google.com ([209.85.220.44]:57364 "EHLO mail-pa0-f44.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751778Ab3FXPWw (ORCPT ); Mon, 24 Jun 2013 11:22:52 -0400 Received: by mail-pa0-f44.google.com with SMTP id lj1so11199106pab.3 for ; Mon, 24 Jun 2013 08:22:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references :in-reply-to:references; bh=nQC/pi+RUmOPmrc2NlcXjeFvwLyWnsABfl2SmnoNNTY=; b=EP/Y2nuwPsAxeR6LXMb2kADixmHxOaPsqEzkL8iJ0GN4wOpGPsa0EbhSh0QApwO5gv lGu3HvhXnEqpMc8vZJ/zKs9UBYfY6PY8IF2Te8mC0fmNXkPWgvEneHoplDl5iiBRJngI Yet/WbJyJkbunpuHeoJcUxflYmOiw8epfODh4Zga+zwV/BP6EOGBuKWnqkjqr7V5FMBQ 1f58vANNpV7KftOipMv479y6CaYCV+buP8wlND7Ub/mNDVZeziTATdyad0Dubw5P68/5 Lor1/1lVEnmtUahQt1SSEB7QhK0W8dP31otzlTllBGMYP5SQj4nvj7+w/yqp3MwaW69C EQFw== X-Received: by 10.68.103.194 with SMTP id fy2mr24031919pbb.158.1372087372091; Mon, 24 Jun 2013 08:22:52 -0700 (PDT) Received: from localhost.localdomain ([114.248.133.39]) by mx.google.com with ESMTPSA id ix3sm18576807pbc.37.2013.06.24.08.22.48 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 24 Jun 2013 08:22:51 -0700 (PDT) X-Mailer: git-send-email 1.8.3.1.756.g41beab0 In-Reply-To: In-Reply-To: References: Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: Add new section "Interactive mode" for documentation of interactive git-clean. Signed-off-by: Jiang Xin Helped-by: Eric Sunshine Signed-off-by: Junio C Hamano --- Documentation/git-clean.txt | 65 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 63 insertions(+), 2 deletions(-) diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 186e34..5bf76 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -39,8 +39,8 @@ OPTIONS -i:: --interactive:: - Show what would be done and the user must confirm before actually - cleaning. + Show what would be done and clean files interactively. See + ``Interactive mode'' for details. -n:: --dry-run:: @@ -69,6 +69,67 @@ OPTIONS Remove only files ignored by Git. This may be useful to rebuild everything from scratch, but keep manually created files. +Interactive mode +---------------- +When the command enters the interactive mode, it shows the +files and directories to be cleaned, and goes into its +interactive command loop. + +The command loop shows the list of subcommands available, and +gives a prompt "What now> ". In general, when the prompt ends +with a single '>', you can pick only one of the choices given +and type return, like this: + +------------ + *** Commands *** + 1: clean 2: filter by pattern 3: select by numbers + 4: ask each 5: quit 6: help + What now> 1 +------------ + +You also could say `c` or `clean` above as long as the choice is unique. + +The main command loop has 6 subcommands. + +clean:: + + Start cleaning files and directories, and then quit. + +filter by pattern:: + + This shows the files and directories to be deleted and issues an + "Input ignore patterns>>" prompt. You can input space-seperated + patterns to exclude files and directories from deletion. + E.g. "*.c *.h" will excludes files end with ".c" and ".h" from + deletion. When you are satisfied with the filtered result, press + ENTER (empty) back to the main menu. + +select by numbers:: + + This shows the files and directories to be deleted and issues an + "Select items to delete>>" prompt. When the prompt ends with double + '>>' like this, you can make more than one selection, concatenated + with whitespace or comma. Also you can say ranges. E.g. "2-5 7,9" + to choose 2,3,4,5,7,9 from the list. If the second number in a + range is omitted, all remaining patches are taken. E.g. "7-" to + choose 7,8,9 from the list. You can say '*' to choose everything. + Also when you are satisfied with the filtered result, press ENTER + (empty) back to the main menu. + +ask each:: + + This will start to clean, and you must confirm one by one in order + to delete items. Please note that this action is not as efficient + as the above two actions. + +quit:: + + This lets you quit without do cleaning. + +help:: + + Show brief usage of interactive git-clean. + SEE ALSO -------- linkgit:gitignore[5] -- 1.8.3.1.756.g41beab0