From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Philip Oakley" Subject: Re: [PATCH] submodule documentation: Reorder introductory paragraphs Date: Fri, 22 May 2015 18:35:41 +0100 Organization: OPDS Message-ID: <05CAAED4A70A416590A620BF584E7F3D@PhilipOakley> References: <1432163517-22785-1-git-send-email-sbeller@google.com><9AF4B2205E154BDA863E8CAAACAE0BDF@PhilipOakley> Reply-To: "Philip Oakley" Mime-Version: 1.0 Content-Type: text/plain; format=flowed; charset="UTF-8"; reply-type=original Content-Transfer-Encoding: 7bit Cc: "Jonathan Nieder" , , "Petr Baudis" , "Heiko Voigt" To: "Stefan Beller" , "Junio C Hamano" X-From: git-owner@vger.kernel.org Fri May 22 19:35:46 2015 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 1YvqrJ-0002xX-J0 for gcvg-git-2@plane.gmane.org; Fri, 22 May 2015 19:35:45 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1422695AbbEVRfl (ORCPT ); Fri, 22 May 2015 13:35:41 -0400 Received: from out1.ip07ir2.opaltelecom.net ([62.24.128.243]:53839 "EHLO out1.ip07ir2.opaltelecom.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1757407AbbEVRfl (ORCPT ); Fri, 22 May 2015 13:35:41 -0400 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: A2ClEAAnaF9VPJBLFlxcgxCBMoMfgy5twzMEBAKBOk0BAQEBAQEHAQEBAUEkG0EDg1kFAQEBAQMIAQEZFR4BASELAgMFAgEDDgcDAgIFIQICFAEEGgYHAxQGARIIAgECAwGIH7AFhlSdZ4EhihmEOkuCby+BFgWTAnmLPJIkg1mBBIMYPTGCRwEBAQ X-IPAS-Result: A2ClEAAnaF9VPJBLFlxcgxCBMoMfgy5twzMEBAKBOk0BAQEBAQEHAQEBAUEkG0EDg1kFAQEBAQMIAQEZFR4BASELAgMFAgEDDgcDAgIFIQICFAEEGgYHAxQGARIIAgECAwGIH7AFhlSdZ4EhihmEOkuCby+BFgWTAnmLPJIkg1mBBIMYPTGCRwEBAQ X-IronPort-AV: E=Sophos;i="5.13,477,1427756400"; d="scan'208";a="157567252" Received: from host-92-22-75-144.as13285.net (HELO PhilipOakley) ([92.22.75.144]) by out1.ip07ir2.opaltelecom.net with ESMTP; 22 May 2015 18:35:40 +0100 X-Priority: 3 X-MSMail-Priority: Normal X-Mailer: Microsoft Outlook Express 6.00.2900.5931 X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: From: "Stefan Beller" > On Fri, May 22, 2015 at 7:36 AM, Junio C Hamano > wrote: >> Stefan Beller writes: >> >>> On Thu, May 21, 2015 at 1:03 PM, Philip Oakley >>> wrote: >>>>> +Submodules are not to be confused with remotes, which are meant >>>>> +mainly for branches of the same project; >>>> >>>> This use of 'branches' didn't work for me. "remotes are meant >>>> mainly for >>>> branches of the same project" ? >> >> The "branch" in the original is used in a much wider sense than >> usual branch (i.e. ref/heads/ thing you have locally); it refers to >> forks of the same project but with a bit of twist. When you say >> repository A is a fork of the same project as my local repository, >> you would give an impression that A is not the authoritative copy of >> the project. But you can say my repository and that repository A >> are branches of the same project, you give zero information as to >> A's authoritativeness. > > While this is correct, I think it is also confusing, because 'branch' > is a command which deals with local branches only in my perception > To deal with remote branches you need to use the commands > {remote, fetch, pull}. > > So when someone mentions "branch" I need to think of local operations > in one repository and not on different distributed histories. > If we are having difficulties defining a "remote" here (its not defined in gitglossary.txt anyway), why not simply put a full stop (period) after the "Submodules are not to be confused with remotes.", and bypass the problem, avoiding digging the hole deeper. >> >>> Submodules should not be confused with remote repositories, >>> which are >>> meant to track the same repository, just at another location; >>> ... >> >> I do not think this is a great improvement. You now conflated >> "repository" to mean "project" in the latter half of the sentence, >> while you are trying to explain what a "remote repository" is. > > That's true. > >> >> Your copy of git.git is not the same repository as mine; they have >> different histories. Both repositories are used to work on the same >> project. "submoules are not remotes, which are other repositories >> of the same project", perhaps? > > That makes sense. > If maybe that the feature we should pick on is the common root of the development between the local and remote repository, and quite distinct for the submodule. This allows remotes to be on the same machine, as well as distant machines and server. It is I believe technically possible to have a submodule which is its own super project, with and without recursion, but would be very atypical, and would belong in the 'don't do that' category