From mboxrd@z Thu Jan 1 00:00:00 1970 From: Matthieu Moy Subject: [PATCH 1/2] git-fast-import.txt: improve documentation for quoted paths Date: Thu, 29 Nov 2012 18:00:54 +0100 Message-ID: <1354208455-21228-1-git-send-email-Matthieu.Moy@imag.fr> References: Cc: Matthieu Moy To: git@vger.kernel.org, gitster@pobox.com X-From: git-owner@vger.kernel.org Thu Nov 29 18:02:31 2012 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 1Te7VD-00047z-66 for gcvg-git-2@plane.gmane.org; Thu, 29 Nov 2012 18:02:19 +0100 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751384Ab2K2RCD (ORCPT ); Thu, 29 Nov 2012 12:02:03 -0500 Received: from mx2.imag.fr ([129.88.30.17]:46348 "EHLO rominette.imag.fr" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751069Ab2K2RCB (ORCPT ); Thu, 29 Nov 2012 12:02:01 -0500 Received: from mail-veri.imag.fr (mail-veri.imag.fr [129.88.43.52]) by rominette.imag.fr (8.13.8/8.13.8) with ESMTP id qATGpebx001362 (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NO); Thu, 29 Nov 2012 17:51:41 +0100 Received: from anie.imag.fr ([129.88.7.32] helo=anie) by mail-veri.imag.fr with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.72) (envelope-from ) id 1Te7UB-0008L3-5S; Thu, 29 Nov 2012 18:01:15 +0100 Received: from moy by anie with local (Exim 4.72) (envelope-from ) id 1Te7UB-0005X1-1e; Thu, 29 Nov 2012 18:01:15 +0100 X-Mailer: git-send-email 1.8.0.319.g8abfee4 In-Reply-To: X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.2.2 (rominette.imag.fr [129.88.30.17]); Thu, 29 Nov 2012 17:51:41 +0100 (CET) X-IMAG-MailScanner-Information: Please contact MI2S MIM for more information X-MailScanner-ID: qATGpebx001362 X-IMAG-MailScanner: Found to be clean X-IMAG-MailScanner-SpamCheck: X-IMAG-MailScanner-From: moy@imag.fr MailScanner-NULL-Check: 1354812703.96384@pHxC++XxuRJAKt1TOYS2EQ Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: The documentation mentionned only newlines and double quotes as characters needing escaping, but the backslash also needs it. Also, the documentation was not clearly saying that double quotes around the file name were required (double quotes in the examples could be interpreted as part of the sentence, not part of the actual string). Signed-off-by: Matthieu Moy --- Documentation/git-fast-import.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index 6603a7a..35b909c 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -558,8 +558,9 @@ A `` string must use UNIX-style directory separators (forward slash `/`), may contain any byte other than `LF`, and must not start with double quote (`"`). -If an `LF` or double quote must be encoded into `` shell-style -quoting should be used, e.g. `"path/with\n and \" in it"`. +If an `LF`, backslash or double quote must be encoded into `` +shell-style quoting should be used, and the complete name should be +surrounded with double quotes e.g. `"path/with\n, \\ and \" in it"`. The value of `` must be in canonical form. That is it must not: -- 1.8.0.319.g8abfee4