Git Mailing List Archive on lore.kernel.org
 help / color / Atom feed
From: Abhishek Kumar <abhishekkumar8222@gmail.com>
To: Kenneth Lorber <keni@hers.com>
Cc: git@vger.kernel.org
Subject: Re: [RFC PATCH 0/6] various documentation bits
Date: Sun, 17 May 2020 13:12:58 +0530
Message-ID: <20200517074258.GA1381@Abhishek-Arch> (raw)
In-Reply-To: <1589681624-36969-1-git-send-email-keni@hers.com>

Hello Kenneth,

On Sat, May 16, 2020 at 10:13:38PM -0400, Kenneth Lorber wrote:
> From: Kenneth Lorber <keni@his.com>
> 
> This started as an effort to understand this section of config.txt:
>   When inventing new variables for use in your own tool, make sure their
>   names do not conflict with those that are used by Git itself and
>   other popular tools, and describe them in your documentation.
> and grew from there.
> 
> I don't expect this to be adopted as is, but I've found it much easier
> to discuss something concrete rather than an abstract "this is
> incomplete" or "this is hard to find."
> 
> Cut from master.
> 
> keni (6):
>   Tell the glossary about core.hooksPath
>   Add bit on extending git to Hacking Git
>   Add namespace collision avoidance guidelines file
>   Include NAMESPACE COLLISIONS doc into gitrepository-layout.txt
>   Tell config.txt about NAMESPACE COLLISIONS
>   Add NAMESPACE COLLISIONS reference to Hacking Git
> 
>  Documentation/config.txt                      |  4 +-
>  Documentation/gitrepository-layout.txt        |  2 +
>  Documentation/glossary-content.txt            | 10 ++-
>  .../technical/namespace-collisions.txt        | 86 +++++++++++++++++++
>  Documentation/user-manual.txt                 |  9 ++
>  5 files changed, 106 insertions(+), 5 deletions(-)
>  create mode 100644 Documentation/technical/namespace-collisions.txt
> 
> -- 
> 2.17.1
> 

Some general notes about your patch series:

1. Conventionally, we prefix the first line with "area: " where the area
is a filename or identifier for general area of the code being modified.
It's customary to start the remainder of the first line after "area: "
with a lower-case letter.

For example, your commit titles could have been:
- doc: tell the glossary about core.hooksPath
- doc: add bit on extending git to hacking Git

and so on.

Check out SubmittingPatches for more information.

2. We generally don't have a line like in our patches:

> From Kenneth Lorber <keni@his.com>

Between the author information and the signed-off-by, it's redundant.

3. You could probably join the patches 3 to 6 together. Or maybe
introduce namespace-collisions.txt in third patch and add references in
all other files in a new, fourth patch.

Thanks for the contribution!

Regards
Abhishek

  parent reply index

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-17  2:13 Kenneth Lorber
2020-05-17  2:13 ` [RFC PATCH 1/6] Tell the glossary about core.hooksPath Kenneth Lorber
2020-05-17 18:33   ` Junio C Hamano
2020-05-18 22:06     ` Kenneth Lorber
2020-05-17  2:13 ` [RFC PATCH 2/6] Add bit on extending git to Hacking Git Kenneth Lorber
2020-05-17 18:34   ` Junio C Hamano
2020-05-18 22:10     ` Kenneth Lorber
2020-05-17  2:13 ` [RFC PATCH 3/6] Add namespace collision avoidance guidelines file Kenneth Lorber
2020-05-17  9:45   ` Abhishek Kumar
2020-05-18 15:51     ` Kenneth Lorber
2020-05-17 15:31   ` Junio C Hamano
2020-05-18 21:46     ` Kenneth Lorber
2020-05-17  2:13 ` [RFC PATCH 4/6] Include NAMESPACE COLLISIONS doc into gitrepository-layout.txt Kenneth Lorber
2020-05-18  0:26   ` Junio C Hamano
2020-05-18 23:54     ` Kenneth Lorber
2020-05-17  2:13 ` [RFC PATCH 5/6] Tell config.txt about NAMESPACE COLLISIONS Kenneth Lorber
2020-05-18  0:32   ` Junio C Hamano
2020-05-17  2:13 ` [RFC PATCH 6/6] Add NAMESPACE COLLISIONS reference to Hacking Git Kenneth Lorber
2020-05-17  7:42 ` Abhishek Kumar [this message]
2020-05-17 18:39   ` [RFC PATCH 0/6] various documentation bits Junio C Hamano
2020-05-18 23:44     ` Kenneth Lorber
2020-05-18 15:45   ` Kenneth Lorber
2020-05-25 23:27 ` [RFC PATCH v2 " Kenneth Lorber
2020-05-25 23:27   ` [RFC PATCH v2 1/6] doc: Tell the glossary about core.hooksPath Kenneth Lorber
2020-05-26 18:59     ` Junio C Hamano
2020-05-27 16:52       ` Kenneth Lorber
2020-05-27 17:18         ` Kenneth Lorber
2020-05-27 17:18         ` Junio C Hamano
2020-05-25 23:27   ` [RFC PATCH v2 2/6] doc: Add bit on extending git to Hacking Git Kenneth Lorber
2020-05-25 23:27   ` [RFC PATCH v2 3/6] doc: Add namespace collision guidelines file Kenneth Lorber
2020-05-28 18:49     ` Junio C Hamano
2020-05-28 19:29       ` Junio C Hamano
2020-05-29  1:20         ` Junio C Hamano
2020-05-29 18:08           ` Junio C Hamano
2020-06-01 23:55         ` Kenneth Lorber
2020-06-01 18:38       ` Kenneth Lorber
2020-05-25 23:27   ` [RFC PATCH v2 4/6] doc: Add collision doc to gitrepository-layout.txt Kenneth Lorber
2020-05-25 23:27   ` [RFC PATCH v2 5/6] doc: Tell config.txt about namespace collisions Kenneth Lorber
2020-05-25 23:27   ` [RFC PATCH v2 6/6] doc: Add collision reference to Hacking Git Kenneth Lorber
2020-05-31 21:37   ` [RFC PATCH 0/2] update glossary hooks entry Kenneth Lorber
2020-05-31 21:37     ` [RFC PATCH 1/2] doc: Tell the glossary about core.hooksPath Kenneth Lorber
2020-05-31 21:37     ` [RFC PATCH 2/2] doc: remove dated info and refs to sample hooks Kenneth Lorber

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200517074258.GA1381@Abhishek-Arch \
    --to=abhishekkumar8222@gmail.com \
    --cc=1589681624-36969-1-git-send-email-keni@hers.com \
    --cc=git@vger.kernel.org \
    --cc=keni@hers.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 Mailing List Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/git/0 git/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 git git/ https://lore.kernel.org/git \
		git@vger.kernel.org
	public-inbox-index git

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.git


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git