From: Junio C Hamano <gitster@pobox.com>
To: "Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Johannes Schindelin <johannes.schindelin@gmx.de>
Subject: Re: [PATCH 1/3] init: document `init.defaultBranch` better
Date: Sun, 22 Nov 2020 15:40:02 -0800 [thread overview]
Message-ID: <xmqqk0udot9p.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <1518387eaa95098707878459bc74bd5ef2179386.1606087406.git.gitgitgadget@gmail.com> (Johannes Schindelin via GitGitGadget's message of "Sun, 22 Nov 2020 23:23:24 +0000")
"Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com>
writes:
> From: Johannes Schindelin <johannes.schindelin@gmx.de>
>
> Our documentation does not mention any future plan to change 'master' to
> other value. It is a good idea to document this, though.
>
> Initial-patch-by: Junio C Hamano <gitster@pobox.com>
> Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
> ---
It would have been nicer to have a reference to the original patch
<xmqqd00a36wc.fsf@gitster.c.googlers.com> here after the three-dash
lines, which would have made it easier for me to say that the
updated phrasing is much better.
I do not think I deserve credit for this step in the series. Please
drop "initial-patch-by" when you do a v2.
> Documentation/git-init.txt | 11 +++++++----
> 1 file changed, 7 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
> index 59ecda6c17..19f9f16e6b 100644
> --- a/Documentation/git-init.txt
> +++ b/Documentation/git-init.txt
> @@ -20,8 +20,9 @@ DESCRIPTION
>
> This command creates an empty Git repository - basically a `.git`
> directory with subdirectories for `objects`, `refs/heads`,
> -`refs/tags`, and template files. An initial `HEAD` file that
> -references the HEAD of the master branch is also created.
> +`refs/tags`, and template files. An initial branch without any
> +commits will be created (see the `--initial-branch` option below
> +for its name).
"branch without any commits" is certainly easier to understand than
"unborn branch", which was in my weatherballoon patch.
Stepping back a bit more, I wonder if we want to make reference to
implementation details even less, e.g.
... an empty Git repository---a `.git` directory to store
objects, branches and tags, hooks, and template files.
which would be in the same spirit as not mentioning 'HEAD file'.
> @@ -73,8 +74,10 @@ If this is reinitialization, the repository will be moved to the specified path.
> -b <branch-name>::
> --initial-branch=<branch-name>::
>
> -Use the specified name for the initial branch in the newly created repository.
> -If not specified, fall back to the default name: `master`.
> +Use the specified name for the initial branch in the newly created
> +repository. If not specified, fall back to the default name (currently
> +`master`, but that will be changed in the future; The name can be customized
> +via the `init.defaultBranch` configuration variable).
s/The/the/ after semicolon that ends a half-sentence. Or
alternatively, s/in the future;/in the future./
>
> --shared[=(false|true|umask|group|all|world|everybody|0xxx)]::
next prev parent reply other threads:[~2020-11-22 23:42 UTC|newest]
Thread overview: 57+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-22 23:23 [PATCH 0/3] Add helpful advice about init.defaultBranch Johannes Schindelin via GitGitGadget
2020-11-22 23:23 ` [PATCH 1/3] init: document `init.defaultBranch` better Johannes Schindelin via GitGitGadget
2020-11-22 23:40 ` Junio C Hamano [this message]
2020-11-23 12:07 ` Johannes Schindelin
2020-11-22 23:23 ` [PATCH 2/3] get_default_branch_name(): prepare for showing some advice Johannes Schindelin via GitGitGadget
2020-11-22 23:23 ` [PATCH 3/3] init: provide useful advice about init.defaultBranch Johannes Schindelin via GitGitGadget
2020-11-22 23:53 ` Junio C Hamano
2020-11-23 2:07 ` Junio C Hamano
2020-11-23 12:28 ` Johannes Schindelin
2020-11-23 18:40 ` Junio C Hamano
2020-11-23 20:46 ` Johannes Schindelin
2020-11-23 21:28 ` Junio C Hamano
2020-11-23 12:26 ` Johannes Schindelin
2020-11-23 12:49 ` Philip Oakley
2020-11-23 20:47 ` Johannes Schindelin
2020-11-23 23:20 ` [PATCH v2 0/4] Add helpful " Johannes Schindelin via GitGitGadget
2020-11-23 23:20 ` [PATCH v2 1/4] init: document `init.defaultBranch` better Johannes Schindelin via GitGitGadget
2020-11-23 23:20 ` [PATCH v2 2/4] branch -m: allow renaming a yet-unborn branch Johannes Schindelin via GitGitGadget
2020-11-23 23:45 ` Junio C Hamano
2020-11-24 5:47 ` Johannes Schindelin
2020-11-24 20:14 ` Junio C Hamano
2020-11-23 23:20 ` [PATCH v2 3/4] get_default_branch_name(): prepare for showing some advice Johannes Schindelin via GitGitGadget
2020-11-23 23:20 ` [PATCH v2 4/4] init: provide useful advice about init.defaultBranch Johannes Schindelin via GitGitGadget
2020-11-23 23:53 ` Junio C Hamano
2020-11-24 5:57 ` Johannes Schindelin
2020-11-24 20:53 ` Junio C Hamano
2020-12-09 14:47 ` Johannes Schindelin
2020-12-09 22:15 ` Junio C Hamano
2020-12-10 12:12 ` Johannes Schindelin
2020-12-10 23:32 ` Junio C Hamano
2020-12-10 0:40 ` Felipe Contreras
2020-11-24 15:07 ` [PATCH v3 0/4] Add helpful " Johannes Schindelin via GitGitGadget
2020-11-24 15:07 ` [PATCH v3 1/4] init: document `init.defaultBranch` better Johannes Schindelin via GitGitGadget
2020-11-24 15:07 ` [PATCH v3 2/4] branch -m: allow renaming a yet-unborn branch Johannes Schindelin via GitGitGadget
2020-11-24 15:07 ` [PATCH v3 3/4] get_default_branch_name(): prepare for showing some advice Johannes Schindelin via GitGitGadget
2020-11-24 15:07 ` [PATCH v3 4/4] init: provide useful advice about init.defaultBranch Johannes Schindelin via GitGitGadget
2020-12-10 21:58 ` [PATCH v4 0/4] Add helpful " Johannes Schindelin via GitGitGadget
2020-12-10 21:58 ` [PATCH v4 1/4] init: document `init.defaultBranch` better Johannes Schindelin via GitGitGadget
2020-12-11 0:24 ` Felipe Contreras
2020-12-11 5:47 ` Junio C Hamano
2020-12-11 6:26 ` Felipe Contreras
2020-12-11 5:59 ` Junio C Hamano
2020-12-10 21:58 ` [PATCH v4 2/4] branch -m: allow renaming a yet-unborn branch Johannes Schindelin via GitGitGadget
2020-12-10 21:58 ` [PATCH v4 3/4] get_default_branch_name(): prepare for showing some advice Johannes Schindelin via GitGitGadget
2020-12-10 21:58 ` [PATCH v4 4/4] init: provide useful advice about init.defaultBranch Johannes Schindelin via GitGitGadget
2020-12-11 0:15 ` Felipe Contreras
2020-12-11 1:22 ` Junio C Hamano
2020-12-11 0:47 ` Johannes Schindelin
2020-12-11 2:00 ` Felipe Contreras
2020-12-11 11:36 ` [PATCH v5 0/4] Add helpful " Johannes Schindelin via GitGitGadget
2020-12-11 11:36 ` [PATCH v5 1/4] init: document `init.defaultBranch` better Johannes Schindelin via GitGitGadget
2020-12-11 11:36 ` [PATCH v5 2/4] branch -m: allow renaming a yet-unborn branch Johannes Schindelin via GitGitGadget
2020-12-11 11:36 ` [PATCH v5 3/4] get_default_branch_name(): prepare for showing some advice Johannes Schindelin via GitGitGadget
2020-12-11 11:36 ` [PATCH v5 4/4] init: provide useful advice about init.defaultBranch Johannes Schindelin via GitGitGadget
2021-02-02 21:24 ` SZEDER Gábor
2021-02-02 22:25 ` Junio C Hamano
2021-02-03 5:20 ` SZEDER Gábor
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=xmqqk0udot9p.fsf@gitster.c.googlers.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=johannes.schindelin@gmx.de \
/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).