From mboxrd@z Thu Jan 1 00:00:00 1970 From: Duy Nguyen Subject: Re: [PATCH 5.5/22] Add documentation for the index api Date: Wed, 10 Jul 2013 12:28:24 +0700 Message-ID: References: <1373184720-29767-1-git-send-email-t.gummerer@gmail.com> <1373184720-29767-6-git-send-email-t.gummerer@gmail.com> <87pputqowr.fsf@gmail.com> <871u78rcw0.fsf@gmail.com> <87wqozpk9s.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Cc: Git Mailing List , Thomas Rast , Michael Haggerty , Junio C Hamano , Robin Rosenberg To: Thomas Gummerer X-From: git-owner@vger.kernel.org Wed Jul 10 07:29:02 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 1UwmxX-00042E-NW for gcvg-git-2@plane.gmane.org; Wed, 10 Jul 2013 07:29:00 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751635Ab3GJF24 (ORCPT ); Wed, 10 Jul 2013 01:28:56 -0400 Received: from mail-oa0-f54.google.com ([209.85.219.54]:63272 "EHLO mail-oa0-f54.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751095Ab3GJF2z (ORCPT ); Wed, 10 Jul 2013 01:28:55 -0400 Received: by mail-oa0-f54.google.com with SMTP id o6so8953776oag.41 for ; Tue, 09 Jul 2013 22:28:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc:content-type; bh=+kLmE9iOega5HRAliFBcSHl2cKnRwzUcubQ7La6bsYg=; b=YtxvjVFjJuqEbuMTwuDGv6vkganmYa6aRs9KvKxvpXeHL/Qy+Z9wsn1mtCsOpAprjy jau+QIx3NzHbTXT80Buk4gSXjs/Sfnvpt0OsqiNn/8w3PUgDeCkHZERZOfMmtD+COhF7 uiDsQ4854T8CUfsRYJVkdFHwt/vgoyN7oZtAR+mF+xmWJuyPlI6DXJHzMOpycnfDzl8R CC5P04XQqmtsCLbbg68Qi64wobbAAxiruYgxk7auu18eE0SjgfJOYWrhfx/51G65um5b M5inGynh9BWGOnHl2QKx4nYu6T1rxQiBxKy0fyIfVi0lRTA1B9OqsNZLTdnAQdjfOfwU QugQ== X-Received: by 10.182.110.164 with SMTP id ib4mr18184834obb.87.1373434134462; Tue, 09 Jul 2013 22:28:54 -0700 (PDT) Received: by 10.76.88.230 with HTTP; Tue, 9 Jul 2013 22:28:24 -0700 (PDT) In-Reply-To: <87wqozpk9s.fsf@gmail.com> Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: On Wed, Jul 10, 2013 at 3:10 AM, Thomas Gummerer wrote: >> If you happen to know that certain entries match the given pathspec, >> you could help the caller avoid match_pathspec'ing again by set a bit >> in ce_flags. > > I currently don't know which entries do match the pathspec from just > reading the index file, additional calls would be needed. I don't think > that would be worth the overhead. Yeah I now see that you select what to load in v5 with the adjusted pathspec, not the input pathspec. Originally I thought you match the input pathspec against every file entry in the index :P Your adjusted pathspec looks like what common_prefix is for. It's cheaper than creating adjusted_pathspec from match_pathspec and reduces loading in major cases, where glob is not used. Still, creating an adjusted pathspec this way looks iffy. You need to understand pathspec in order to strip the filename part out to match the directory match only. An alternative is use tree_entry_interesting. It goes along well with tree traversal and can be used to match directories with original pathspec. Once you see it matches an entry in a directory, you could skip matching the rest of the files and load the whole directory. read_index_filtered_v5 and read_entries may need some tweaking though. I'll try it and post a patch later if I succeed. >> To know which entry exists in the index and which is >> new, use another flag. Most reader code won't change if we do it this >> way, all match_pathspec() remain where they are. > > Hrm you mean to know which cache entries are added (or changed) in the > in-memory index and will have to be written later? I'm not sure I > understand correctly what you mean here. Oh.. The "to know.." sentence was nonsense. We probably don't need to know. We may track changed entries for partial writing, but let's leave that out for now. >>> +`index_change_filter_opts(opts)`:: >>> + This function again has a slightly different functionality for >>> + index-v2 and index-v5. >>> + >>> + For index-v2 it simply changes the filter_opts, so >>> + for_each_index_entry uses the changed index_opts, to iterate >>> + over a different set of cache entries. >>> + >>> + For index-v5 it refreshes the index if the filter_opts have >>> + changed and sets the new filter_opts in the index state, again >>> + to iterate over a different set of cache entries as with >>> + index-v2. >>> + >>> + This has some optimization potential, in the case that the >>> + opts get stricter (less of the index should be read) it >>> + doesn't have to reload anything, but currently does. >> >> The only use case I see so far is converting a partial index_state >> back to a full one. Apart from doing so in order to write the new >> index, I think some operation (like rename tracking in diff or >> unpack-trees) may expect full index. I think we should support that. I >> doubt we need to change pathspec to something different than the one >> we used to load the index. When a user passes a pathspec to a command, >> the user expects the command to operate on that set only, not outside. > > One application was in ls-files, where we strip the trailing slash from > the pathspecs for submodules. But when we let the caller filter the > rest out it's not needed anymore. We load all entries without the > trailing slash anyway. That submodule trailing slash stripping code will be moved away soon (I've been working on it for some time now). There's similar code in pathspec.c. I hope by the time this series becomes a candidate for 'next', those pathspec manipulation is already gone. For strip_trailing_slash_from_submodules, peeking in index file for a few entries is probably ok. For check_path_for_gitlink, full index is loaded until we figure out a clever way. >> Some thoughts about the writing api. >> >> In think we should avoid automatically converting partial index into a >> full one before writing. Push that back to the caller and die() when >> asked to update partial index. They know at what point the index may >> be updated and even what part of it may be updated. I think all >> commands fall into two categories, tree-wide updates (merge, >> checkout...) and limited by the user-given pathspec. "what part to be >> updated" is not so hard to determine. > > Hrm this is only true if index entries are added or removed, not if they > are only changed. If they are only changed we can write a partially > read index once we have partial writing. Yep. We can detect if changes are updates only, no additions nor removals. If so do partial write, else full write. These little details are hidden from the user, as long as they keep their promise about read/write regions. > For now it would make sense to just die() though, until we have that in place. Agreed. -- Duy