From mboxrd@z Thu Jan 1 00:00:00 1970 From: Dmitry Ivankov Subject: [PATCH 1/3] doc/fast-import: clarify notemodify command Date: Tue, 12 Jul 2011 21:10:26 +0600 Message-ID: <1310483428-29833-2-git-send-email-divanorama@gmail.com> References: <1310483428-29833-1-git-send-email-divanorama@gmail.com> Cc: Junio C Hamano , Jonathan Nieder , Ramkumar Ramachandra , Johan Herland , "Shawn O. Pearce" , Dmitry Ivankov To: git@vger.kernel.org X-From: git-owner@vger.kernel.org Tue Jul 12 17:10:38 2011 Return-path: Envelope-to: gcvg-git-2@lo.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Qgebd-0005YJ-F9 for gcvg-git-2@lo.gmane.org; Tue, 12 Jul 2011 17:10:37 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753288Ab1GLPKS (ORCPT ); Tue, 12 Jul 2011 11:10:18 -0400 Received: from mail-bw0-f46.google.com ([209.85.214.46]:52328 "EHLO mail-bw0-f46.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752208Ab1GLPKN (ORCPT ); Tue, 12 Jul 2011 11:10:13 -0400 Received: by bwd5 with SMTP id 5so4115732bwd.19 for ; Tue, 12 Jul 2011 08:10:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; bh=YZC5R7MtGtKWNRUQgiw3lu5u132Exyj3mgSV6DXZsKc=; b=ce6gWyE/XiAYh3HosbjdgI6VjSxs05iN0G+LNkfh0acS0/5JgM2RW10C6DZ+fjvPiv giYWnbumSHRS7kXBFAmcpK7ALTG5t2uTDLS31Os4KgtCTO8eOayISbaQQ1UmRNvwNHEB +Wpq3nmtEn9CuqwMW3G+tUazBJfaJJJtxRgL0= Received: by 10.204.154.201 with SMTP id p9mr14888bkw.283.1310483412636; Tue, 12 Jul 2011 08:10:12 -0700 (PDT) Received: from localhost.localdomain (117360277.convex.ru [79.172.62.237]) by mx.google.com with ESMTPS id u32sm1398878bkk.49.2011.07.12.08.10.10 (version=TLSv1/SSLv3 cipher=OTHER); Tue, 12 Jul 2011 08:10:11 -0700 (PDT) X-Mailer: git-send-email 1.7.3.4 In-Reply-To: <1310483428-29833-1-git-send-email-divanorama@gmail.com> Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: The "notemodify" fast-import command was introduced in commit a8dd2.. The commit log has slightly different description than the added documentation. The latter is somewhat confusing. "notemodify" is a subcommand of "commit" command used to add a note for some commit. Does this note annotate the commit produced by the "commit" command or a commit given by it's committish parameter? Which notes tree does it write notes to? The exact meaning could be deduced with old description and some notes machinery knowledge. But let's make it more obvious. This command is used in a context like "commit refs/notes/test" to add or rewrite an annotation for a committish parameter. So the advised way to add notes in a fast-import stream is: 1) import some commits (optional) 2) prepare a "commit" to the notes tree: 2.1) choose notes ref, committer, log message, etc. 2.2) create annotations with "notemodify", where each can refer to a commit being annotated via a branch name, import mark reference, sha1 and other expressions specified in the Documentation. Signed-off-by: Dmitry Ivankov --- Documentation/git-fast-import.txt | 11 ++++++++--- 1 files changed, 8 insertions(+), 3 deletions(-) diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index 249249a..3f5b912 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -648,9 +648,14 @@ paths for a commit are encouraged to do so. `notemodify` ^^^^^^^^^^^^ -Included in a `commit` command to add a new note (annotating a given -commit) or change the content of an existing note. This command has -two different means of specifying the content of the note. +Included in a `commit` `` command to add a new note +annotating a `` or change this annotation contents. +Internally it is similar to filemodify 100644 on `` +path (maybe split into subdirectories). It's not advised to +use any other commands to write to the `` tree except +`filedeleteall` to delete all existing notes in this tree. +This command has two different means of specifying the content +of the note. External data format:: The data content for the note was already supplied by a prior -- 1.7.3.4