From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Derrick Stolee" <stolee@gmail.com>, "Jeff King" <peff@peff.net>,
"Felipe Contreras" <felipe.contreras@gmail.com>,
"Bagas Sanjaya" <bagasdotme@gmail.com>,
"Robert Karszniewicz" <avoidr@posteo.de>,
"Emily Shaffer" <emilyshaffer@google.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH 5/6] doc: replace "alice" and "bob" with "jdoe" and "msmith"
Date: Tue, 15 Jun 2021 18:18:02 +0200 [thread overview]
Message-ID: <patch-5.6-65b7123e701-20210615T161330Z-avarab@gmail.com> (raw)
In-Reply-To: <cover-0.6-00000000000-20210615T161330Z-avarab@gmail.com>
Change the "Alice" and "Bob" generic example users to jdoe@example.com
and msmith@example.com.
The former is widely used in RFC 5322 as an example E-Mail address,
the latter is not, but "Mary Smith <mary@example.com>". It has been
claimed that any reference to people's gender in our documentation is
distracting to some readers[1]. In this case it's easy enough to tweak
the example in such a way that the reader can insert their own
stand-in for "M.".
1. https://lore.kernel.org/git/pull.975.v3.git.1623766273.gitgitgadget@gmail.com/
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
Documentation/git-credential.txt | 2 +-
Documentation/git-imap-send.txt | 4 ++--
Documentation/git-interpret-trailers.txt | 22 +++++++++++-----------
3 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/Documentation/git-credential.txt b/Documentation/git-credential.txt
index 206e3c5f407..86b4c32affa 100644
--- a/Documentation/git-credential.txt
+++ b/Documentation/git-credential.txt
@@ -69,7 +69,7 @@ information it has):
protocol=https
host=example.com
- username=bob
+ username=jdoe
password=secr3t
+
In most cases, this means the attributes given in the input will be
diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt
index 63cf498ce9f..902f0e8ed34 100644
--- a/Documentation/git-imap-send.txt
+++ b/Documentation/git-imap-send.txt
@@ -72,7 +72,7 @@ Using direct mode:
[imap]
folder = "INBOX.Drafts"
host = imap://imap.example.com
- user = bob
+ user = jdoe
pass = p4ssw0rd
.........................
@@ -82,7 +82,7 @@ Using direct mode with SSL:
[imap]
folder = "INBOX.Drafts"
host = imaps://imap.example.com
- user = bob
+ user = jdoe
pass = p4ssw0rd
port = 123
; sslVerify = false
diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
index 956a01d184f..17a19960ba3 100644
--- a/Documentation/git-interpret-trailers.txt
+++ b/Documentation/git-interpret-trailers.txt
@@ -277,13 +277,13 @@ $ cat msg.txt
subject
message
-$ cat msg.txt | git interpret-trailers --trailer 'sign: Alice <alice@example.com>' --trailer 'sign: Bob <bob@example.com>'
+$ cat msg.txt | git interpret-trailers --trailer 'sign: J. Doe <jdoe@example.com>' --trailer 'sign: M. Smith <msmith@example.com>'
subject
message
-Signed-off-by: Alice <alice@example.com>
-Signed-off-by: Bob <bob@example.com>
+Signed-off-by: J. Doe <jdoe@example.com>
+Signed-off-by: M. Smith <msmith@example.com>
------------
* Use the `--in-place` option to edit a message file in place:
@@ -294,15 +294,15 @@ subject
message
-Signed-off-by: Bob <bob@example.com>
-$ git interpret-trailers --trailer 'Acked-by: Alice <alice@example.com>' --in-place msg.txt
+Signed-off-by: M. Smith <msmith@example.com>
+$ git interpret-trailers --trailer 'Acked-by: J. Doe <jdoe@example.com>' --in-place msg.txt
$ cat msg.txt
subject
message
-Signed-off-by: Bob <bob@example.com>
-Acked-by: Alice <alice@example.com>
+Signed-off-by: M. Smith <msmith@example.com>
+Acked-by: J. Doe <jdoe@example.com>
------------
* Extract the last commit as a patch, and add a 'Cc' and a
@@ -311,7 +311,7 @@ Acked-by: Alice <alice@example.com>
------------
$ git format-patch -1
0001-foo.patch
-$ git interpret-trailers --trailer 'Cc: Alice <alice@example.com>' --trailer 'Reviewed-by: Bob <bob@example.com>' 0001-foo.patch >0001-bar.patch
+$ git interpret-trailers --trailer 'Cc: J. Doe <jdoe@example.com>' --trailer 'Reviewed-by: M. Smith <msmith@example.com>' 0001-foo.patch >0001-bar.patch
------------
* Configure a 'sign' trailer with a command to automatically add a
@@ -326,12 +326,12 @@ $ git config trailer.sign.command 'echo "$(git config user.name) <$(git config u
$ git interpret-trailers <<EOF
> EOF
-Signed-off-by: Bob <bob@example.com>
+Signed-off-by: M. Smith <msmith@example.com>
$ git interpret-trailers <<EOF
-> Signed-off-by: Alice <alice@example.com>
+> Signed-off-by: J. Doe <jdoe@example.com>
> EOF
-Signed-off-by: Alice <alice@example.com>
+Signed-off-by: J. Doe <jdoe@example.com>
------------
* Configure a 'fix' trailer with a key that contains a '#' and no
--
2.32.0.555.g0268d380f7b
next prev parent reply other threads:[~2021-06-15 16:19 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-15 16:17 [PATCH 0/6] doc: replace "alice" and "bob" examples Ævar Arnfjörð Bjarmason
2021-06-15 16:17 ` [PATCH 1/6] gittutorial doc: replace "alice" and "bob" with "you" and "www-data" Ævar Arnfjörð Bjarmason
2021-06-16 3:43 ` Bagas Sanjaya
2021-06-16 4:50 ` Junio C Hamano
2021-06-16 21:04 ` Felipe Contreras
2021-06-17 20:38 ` Ævar Arnfjörð Bjarmason
2021-06-15 16:17 ` [PATCH 2/6] gitcvs-migration " Ævar Arnfjörð Bjarmason
2021-06-16 4:02 ` Bagas Sanjaya
2021-06-15 16:18 ` [PATCH 3/6] daemon doc + code comments: reword "alice" example Ævar Arnfjörð Bjarmason
2021-06-15 16:18 ` [PATCH 4/6] fast-import doc: change "bob" in an example to "file.txt" Ævar Arnfjörð Bjarmason
2021-06-15 16:18 ` Ævar Arnfjörð Bjarmason [this message]
2021-06-15 16:18 ` [PATCH 6/6] pack-protocol doc: use "www-data" in place of "alice" Ævar Arnfjörð Bjarmason
2021-06-15 16:46 ` [PATCH 0/6] doc: replace "alice" and "bob" examples Robert P. J. Day
2021-06-15 18:45 ` Ævar Arnfjörð Bjarmason
2021-06-15 16:54 ` Felipe Contreras
2021-06-15 19:09 ` Ævar Arnfjörð Bjarmason
2021-06-16 20:56 ` Felipe Contreras
2021-06-17 15:48 ` Phillip Susi
2021-06-17 20:51 ` Ævar Arnfjörð Bjarmason
2021-06-16 1:52 ` Junio C Hamano
2021-06-16 9:30 ` Robert P. J. Day
2021-06-16 12:00 ` Jeff King
2021-06-16 20:59 ` Felipe Contreras
2021-06-16 21:02 ` Randall S. Becker
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=patch-5.6-65b7123e701-20210615T161330Z-avarab@gmail.com \
--to=avarab@gmail.com \
--cc=avoidr@posteo.de \
--cc=bagasdotme@gmail.com \
--cc=emilyshaffer@google.com \
--cc=felipe.contreras@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
--cc=stolee@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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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 NNTP newsgroup(s).