From: Stefan Beller <sbeller@google.com> To: Kaartic Sivaraam <kaartic.sivaraam@gmail.com> Cc: Git mailing list <git@vger.kernel.org> Subject: Re: [PATCH 6/8] Doc/gitsubmodules: improve readability of certain lines Date: Tue, 9 Jan 2018 11:31:56 -0800 Message-ID: <CAGZ79kbQoLCodgR+JGXf_K1kS2Orjzp3W+7ZQBM0gX9je6d3Rg@mail.gmail.com> (raw) In-Reply-To: <f82949ed-5dbd-eab4-d917-8fe675b1c517@gmail.com> >>> The submodule's `$GIT_DIR/config` file would come into play when running >>> `git push --recurse-submodules=check` in the superproject, as this would >>> @@ -107,13 +108,13 @@ If the submodule is not yet initialized, then the configuration >>> inside the submodule does not exist yet, so configuration where to >>> obtain the submodule from is configured here for example. >>> > > I caught this in the context while replying. "so configuration where to > obtain the submodule from is configured here for example." doesn't seem > to read well. Maybe removing configuration from the sentence will make > it sound better? > > >>> - * the `.gitmodules` file inside the superproject. Additionally to the >>> - required mapping between submodule's name and path, a project usually >>> + * The `.gitmodules` file inside the superproject. Additionally, if mapping >>> + is required between a submodule's name and its path, a project usually >> >> This changes meaning, originally it tries to say: >> >> * it requires mapping path <-> names. > > I get this ... > >> * but there can be more. > > ... but not this. Did the previous version really try to say this? > Anyways how does this sound? Well that was me being very sloppy trying to say that there might be submodule.<name>.{url, ignored, shallow} settings which just happen to be there. > * The `.gitmodules` file inside the superproject. A project usually > uses this file to suggest defaults for the upstream collection > of repositories for the mapping that is required between a > submodule's name and its path. > > I think it conveys the "it requires mapping path <-> names." correctly > but doesn't convey the "but there can be more." part. I'm not sure how > to get that into the sentence, correctly. I did not consider that part the important part, hence my sloppiness. Sorry for the confusion. My main point was to say that the mapping is the important part and must be found in the .gitmodules file, otherwise we do not consider it a submodule (for whatever "it" is, maybe a gitlink at a path=name). Stefan
next prev parent reply index Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top 2018-01-06 18:46 [PATCH 0/8] Doc/submodules: a few updates Kaartic Sivaraam 2018-01-06 18:46 ` [PATCH 1/8] Doc/gitsubmodules: split a sentence for better readability Kaartic Sivaraam 2018-01-07 0:29 ` Eric Sunshine 2018-01-08 18:33 ` Stefan Beller 2018-01-06 18:46 ` [PATCH 2/8] Doc/gitsubmodules: clearly specify advantage of submodule Kaartic Sivaraam 2018-01-08 18:36 ` Stefan Beller 2018-01-09 15:58 ` Kaartic Sivaraam 2018-01-06 18:46 ` [PATCH 3/8] Doc/gitsubmodules: specify how submodules help in reduced size Kaartic Sivaraam 2018-01-07 0:31 ` Eric Sunshine 2018-01-08 18:38 ` Stefan Beller 2018-01-09 16:01 ` Kaartic Sivaraam 2018-01-09 19:01 ` Stefan Beller 2018-01-09 19:30 ` Kaartic Sivaraam 2018-01-06 18:46 ` [PATCH 4/8] Doc/gitsubmodules: avoid abbreviations Kaartic Sivaraam 2018-01-07 0:36 ` Eric Sunshine 2018-01-08 18:45 ` Stefan Beller 2018-01-09 16:06 ` Kaartic Sivaraam 2018-01-09 19:26 ` Stefan Beller 2018-01-09 19:32 ` Kaartic Sivaraam 2018-01-06 18:46 ` [PATCH 5/8] Doc/gitsubmodules: use "Git directory" consistently Kaartic Sivaraam 2018-01-07 0:39 ` Eric Sunshine 2018-01-08 18:45 ` Stefan Beller 2018-01-06 18:46 ` [PATCH 6/8] Doc/gitsubmodules: improve readability of certain lines Kaartic Sivaraam 2018-01-07 0:44 ` Eric Sunshine 2018-01-08 18:49 ` Stefan Beller 2018-01-09 16:37 ` Kaartic Sivaraam 2018-01-09 19:31 ` Stefan Beller [this message] 2018-01-09 19:57 ` Kaartic Sivaraam 2018-01-06 18:46 ` [PATCH 7/8] Doc/git-submodule: improve readability and grammar of a sentence Kaartic Sivaraam 2018-01-08 18:57 ` Stefan Beller 2018-01-06 18:46 ` [PATCH 8/8] Doc/git-submodule: correctly quote important words Kaartic Sivaraam 2018-01-08 19:08 ` [PATCH 0/8] Doc/submodules: a few updates Stefan Beller 2018-01-09 17:06 ` Kaartic Sivaraam 2018-01-09 18:50 ` Stefan Beller 2018-01-10 6:49 ` [PATCH v2 0/2] " Kaartic Sivaraam 2018-01-10 6:49 ` [PATCH v2 1/2] Doc/gitsubmodules: make some changes to improve readability and syntax Kaartic Sivaraam 2018-01-10 20:49 ` Stefan Beller 2018-01-10 6:49 ` [PATCH v2 2/2] Doc/git-submodule: improve readability and grammar of a sentence Kaartic Sivaraam 2018-01-14 17:37 ` [PATCH v3 0/2] Doc/submodules: a few updates Kaartic Sivaraam 2018-01-14 17:37 ` [PATCH v3 1/2] Doc/gitsubmodules: make some changes to improve readability and syntax Kaartic Sivaraam 2018-01-16 20:03 ` Stefan Beller 2018-01-14 17:37 ` [PATCH v3 2/2] Doc/git-submodule: improve readability and grammar of a sentence Kaartic Sivaraam 2018-01-16 20:02 ` [PATCH v3 0/2] Doc/submodules: a few updates Junio C Hamano 2018-01-17 2:45 ` Kaartic Sivaraam
Reply instructions: You may reply publically to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style List information: http://vger.kernel.org/majordomo-info.html * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=CAGZ79kbQoLCodgR+JGXf_K1kS2Orjzp3W+7ZQBM0gX9je6d3Rg@mail.gmail.com \ --to=sbeller@google.com \ --cc=git@vger.kernel.org \ --cc=kaartic.sivaraam@gmail.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
git@vger.kernel.org mailing list mirror (one of many) Archives are clonable: git clone --mirror https://public-inbox.org/git git clone --mirror http://ou63pmih66umazou.onion/git git clone --mirror http://czquwvybam4bgbro.onion/git git clone --mirror http://hjrcffqmbrq6wope.onion/git Newsgroups are available over NNTP: nntp://news.public-inbox.org/inbox.comp.version-control.git nntp://ou63pmih66umazou.onion/inbox.comp.version-control.git nntp://czquwvybam4bgbro.onion/inbox.comp.version-control.git nntp://hjrcffqmbrq6wope.onion/inbox.comp.version-control.git nntp://news.gmane.org/gmane.comp.version-control.git note: .onion URLs require Tor: https://www.torproject.org/ or Tor2web: https://www.tor2web.org/ AGPL code for this site: git clone https://public-inbox.org/ public-inbox