From: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
To: Stefan Beller <sbeller@google.com>
Cc: Junio C Hamano <gitster@pobox.com>,
"git@vger.kernel.org" <git@vger.kernel.org>
Subject: Re: [PATCH/RFC] Cleanup Documentation
Date: Tue, 20 Jun 2017 23:57:53 +0530 [thread overview]
Message-ID: <1497983273.28187.9.camel@gmail.com> (raw)
In-Reply-To: <CAGZ79kbJx4p2y6Vjp3dVBP2pd=MYa_j3Mxfv=zUygHY-bHj0wQ@mail.gmail.com>
On Tue, 2017-06-20 at 09:57 -0700, Stefan Beller wrote:
> canonical: "according to recognized rules or scientific laws."
> sounds about right. :)
>
I actually used as I found it to have the meaning of "conforming to
orthodox or recognized rules" :)
> While this was just reflowed and not newly introduced, I am still
> left wondering what a changeset is in Git terms. Our
> Documentation/glossary says:
>
> [[def_changeset]]changeset::
> BitKeeper/cvsps speak for "<<def_commit,commit>>". Since Git does
> not store changes, but states, it really does not make sense to use
> the term "changesets" with Git.
>
> Maybe we should say instead:
>
> If <path>exists and is already a valid Git repository,
> then this is staged for commit without cloning.
>
Does seem to be a good change to make. Done.
On Tue, 2017-06-20 at 10:05 -0700, Stefan Beller wrote:
> > On Tue, Jun 20, 2017 at 9:57 AM, Stefan Beller <sbeller@google.com>
> > wrote:
> > >
> > > With or without this nit addressed, this patch looks good to me,
> > >
> >
> > Well actually not quite. The subject (and commit message) is very
> > vague,
> > maybe:
>
> > Documentation/git-submodule: cleanup "add" section
> >
> > The "add" section for 'git-submodule' is redundant in its
> > description and
> > the short synopsis line. Remove the redundant mentioning of the
> > 'repository' argument being mandatory.
> >
> > The text is hard to read because of back-references, so remove
> > those.
> >
> > Replace the word "humanish" by "canonical" as that conveys
> better
> > what
> > we do to guess the path.
> >
> > While at it, quote all occurrences of '.gitmodules' as that is
> an
> > important
> > file in the submodule context, also link to it on its first
> > mention.
> > (This paragraph is not exactly what happens in the commit, but
> I
> > wrote it
> > as a way how I would write commit messages. It shows the reader
> > how
> > you addressed the given problem, with the quantifiers "all"
> "the
> > first" showing
> > what you think is important, and that you deliberately omitted
> > others)
>
Made this change too.
--
Regards,
Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
prev parent reply other threads:[~2017-06-20 18:28 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-19 3:05 [PATCH/RFC] Cleanup Documentation Kaartic Sivaraam
2017-06-19 5:24 ` Junio C Hamano
2017-06-19 5:50 ` Stefan Beller
2017-06-19 17:33 ` Kaartic Sivaraam
2017-06-19 17:54 ` Stefan Beller
2017-06-20 3:12 ` Kaartic Sivaraam
2017-06-20 16:57 ` Stefan Beller
2017-06-20 17:05 ` Stefan Beller
2017-06-21 3:02 ` [PATCH/FINALRFC] Documentation/git-submodule: cleanup Kaartic Sivaraam
2017-06-21 16:11 ` Junio C Hamano
2017-06-21 17:41 ` Kaartic Sivaraam
2017-06-22 2:51 ` [PATCH/FINAL] " Kaartic Sivaraam
2017-06-22 19:07 ` Junio C Hamano
2017-06-22 19:13 ` Stefan Beller
2017-06-20 18:27 ` Kaartic Sivaraam [this message]
Reply instructions:
You may reply publicly 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=1497983273.28187.9.camel@gmail.com \
--to=kaarticsivaraam91196@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=sbeller@google.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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).