{"thread":{"id":"18779","subject":"[PATCH 1/2] Clarify the gitmodules and submodules docs","startedAt":"2009-04-08T07:04:46Z","lastAt":"2009-04-08T07:16:10Z","messageCount":2,"participants":["P Baker","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"110800","messageId":"526944450904080004r1249d1b8j4a44472d72502b9c@mail.gmail.com","threadId":"18779","inReplyTo":"1239172816-38966-1-git-send-email-pbaker@retrodict.com","subject":"[PATCH 1/2] Clarify the gitmodules and submodules docs","fromName":"P Baker","fromEmail":"me@retrodict.com","sentAt":"2009-04-08T07:04:46Z","receivedAt":"2009-04-08T07:04:46Z","isPatch":true,"sender":{"key":"me@retrodict.com","avatar":null},"body":"Added some explanation to the docs to clear up some confusing parts of\ngit-submodules that appeared frequently on the mailing list.\n\n Signed-off-by: pbaker <pbaker@retrodict.com>\n ---\n\n As I dug into the reasoning and structure of git-submodule as part of\nGSoC preparation, I also ran across frequently asked questions on the\nmailing list. From this background, I added some explanation to the\ndocs to  clear up some confusing parts of git-submodules.\n\n - pbaker\n\n Documentation/git-submodule.txt |    9 ++++++---\n  Documentation/gitmodules.txt    |    8 +++++++-\n  2 files changed, 13 insertions(+), 4 deletions(-)\n\n diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt\n index 3b8df44..1ca8184 100644\n --- a/Documentation/git-submodule.txt\n +++ b/Documentation/git-submodule.txt\n @@ -50,9 +50,12 @@ This command will manage the tree entries and\ncontents of the\n  gitmodules file for you, as well as inspect the status of your\n  submodules and update them.\n  When adding a new submodule to the tree, the 'add' subcommand\n -is to be used.  However, when pulling a tree containing submodules,\n -these will not be checked out by default;\n -the 'init' and 'update' subcommands will maintain submodules\n +is to be used. This creates a record in the gitmodules file for each\n +submodule. When the file is committed and pulled by others it serves as an\n +in-tree reference for where to obtain the submodule.\n +\n +When pulling a tree containing submodules, these will not be checked out by\n +default; the 'init' and 'update' subcommands will maintain submodules\n  checked out and at appropriate revision in your working tree.\n  You can briefly inspect the up-to-date status of your submodules\n  using the 'status' subcommand and get a detailed overview of the\n diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt\n index d1a17e2..8f03310 100644\n --- a/Documentation/gitmodules.txt\n +++ b/Documentation/gitmodules.txt\n @@ -15,7 +15,13 @@ DESCRIPTION\n\n  The `.gitmodules` file, located in the top-level directory of a git\n  working tree, is a text file with a syntax matching the requirements\n -of linkgit:git-config[1].\n +of linkgit:git-config[1]. As this file is managed by Git, it tracks the\n +records of a project's submodules. Information stored in this file is used\n +as a hint to prime the authoritative version of the record stored in the\n +project configuration file. User specific record changes (e.g. to account\n +for differences in submodule URLs due to networking situations) should be\n +made to the configuration file, while record changes to be propagated (e.g.\n +due to a relocation of the submodule source) should be made to this file.\n\n  The file contains one subsection per submodule, and the subsection value\n  is the name of the submodule. Each submodule section also contains the\n --\n 1.6.2.1.316.gedbc2\n"},{"id":"110803","messageId":"7vljqbpqdh.fsf@gitster.siamese.dyndns.org","threadId":"18779","inReplyTo":"526944450904080004r1249d1b8j4a44472d72502b9c@mail.gmail.com","subject":"Re: [PATCH 1/2] Clarify the gitmodules and submodules docs","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2009-04-08T07:16:10Z","receivedAt":"2009-04-08T07:16:10Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"I think the new description is good, and the message claims to be sent by\nsend-email, but I am seeing a funny whitespace damage everywhere in your\npatch.\n\n * Signed-off-by: and the three-dash lines have a leading SP\n\n * The first line of diffstat is indented by one SP as expected; the\n   second line has one extra SP at the beginning.\n\n * everything after that has one extra SP at the beginning.  Also the hunk\n   header for the first hunk is linewrapped.\n\nVery curious.  I could just hand munge the patch if I wanted to, but I'd\nrather not.  As you are in \"GSoC preparation\", I expect to receive\npatches, perhaps tons of them, from you in the future, and I'd want to see\neasier procedural wrinkles straightened out first.  That will allow us to\nconcentrate on the substance when \"the real thing\" starts.\n\n    Added some explanation to the docs to clear up some confusing parts of\n    git-submodules that appeared frequently on the mailing list.\n\nWe tend to say \"Add some explanation...\" here.  Think of it as your giving\nan order to _me_, \"cause this to happen\", by accepting and applying your\npatch.\n"}]}