Change the "Alice" and "Bob" generic example users to jdoe@xxxxxxxxxxx and msmith@xxxxxxxxxxx. The former is widely used in RFC 5322 as an example E-Mail address, the latter is not, but "Mary Smith <mary@xxxxxxxxxxx>". 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@xxxxxxxxx/ Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@xxxxxxxxx> --- 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@xxxxxxxxxxx>' --trailer 'sign: Bob <bob@xxxxxxxxxxx>' +$ cat msg.txt | git interpret-trailers --trailer 'sign: J. Doe <jdoe@xxxxxxxxxxx>' --trailer 'sign: M. Smith <msmith@xxxxxxxxxxx>' subject message -Signed-off-by: Alice <alice@xxxxxxxxxxx> -Signed-off-by: Bob <bob@xxxxxxxxxxx> +Signed-off-by: J. Doe <jdoe@xxxxxxxxxxx> +Signed-off-by: M. Smith <msmith@xxxxxxxxxxx> ------------ * Use the `--in-place` option to edit a message file in place: @@ -294,15 +294,15 @@ subject message -Signed-off-by: Bob <bob@xxxxxxxxxxx> -$ git interpret-trailers --trailer 'Acked-by: Alice <alice@xxxxxxxxxxx>' --in-place msg.txt +Signed-off-by: M. Smith <msmith@xxxxxxxxxxx> +$ git interpret-trailers --trailer 'Acked-by: J. Doe <jdoe@xxxxxxxxxxx>' --in-place msg.txt $ cat msg.txt subject message -Signed-off-by: Bob <bob@xxxxxxxxxxx> -Acked-by: Alice <alice@xxxxxxxxxxx> +Signed-off-by: M. Smith <msmith@xxxxxxxxxxx> +Acked-by: J. Doe <jdoe@xxxxxxxxxxx> ------------ * Extract the last commit as a patch, and add a 'Cc' and a @@ -311,7 +311,7 @@ Acked-by: Alice <alice@xxxxxxxxxxx> ------------ $ git format-patch -1 0001-foo.patch -$ git interpret-trailers --trailer 'Cc: Alice <alice@xxxxxxxxxxx>' --trailer 'Reviewed-by: Bob <bob@xxxxxxxxxxx>' 0001-foo.patch >0001-bar.patch +$ git interpret-trailers --trailer 'Cc: J. Doe <jdoe@xxxxxxxxxxx>' --trailer 'Reviewed-by: M. Smith <msmith@xxxxxxxxxxx>' 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@xxxxxxxxxxx> +Signed-off-by: M. Smith <msmith@xxxxxxxxxxx> $ git interpret-trailers <<EOF -> Signed-off-by: Alice <alice@xxxxxxxxxxx> +> Signed-off-by: J. Doe <jdoe@xxxxxxxxxxx> > EOF -Signed-off-by: Alice <alice@xxxxxxxxxxx> +Signed-off-by: J. Doe <jdoe@xxxxxxxxxxx> ------------ * Configure a 'fix' trailer with a key that contains a '#' and no -- 2.32.0.555.g0268d380f7b
