All of lore.kernel.org
 help / color / mirror / Atom feed
From: Phillip Susi <phill@thesusis.net>
To: Felipe Contreras <felipe.contreras@gmail.com>
Cc: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
	git@vger.kernel.org, "Junio C Hamano" <gitster@pobox.com>,
	"Derrick Stolee" <stolee@gmail.com>, "Jeff King" <peff@peff.net>,
	"Bagas Sanjaya" <bagasdotme@gmail.com>,
	"Robert Karszniewicz" <avoidr@posteo.de>,
	"Emily Shaffer" <emilyshaffer@google.com>
Subject: Re: [PATCH 0/6] doc: replace "alice" and "bob" examples
Date: Thu, 17 Jun 2021 11:48:00 -0400	[thread overview]
Message-ID: <87pmwkh4he.fsf@vps.thesusis.net> (raw)
In-Reply-To: <60ca6586607f5_602720852@natae.notmuch>


Felipe Contreras <felipe.contreras@gmail.com> writes:

> I have not read cryptography documentation, so for me Alice and Bob are
> simply two illustrative colleagues.

I have read cryptography documentation and seen Alice and Bob used
commonly.  Am I supposed to be confused if I see those names used in
documentation for non cryptographic software?  If Alice and Bob work
there, why should they not be used here?  Am I missing something?

>> And as argued in 1/6 for those users who /are/ aware of "Alice and Bob"
>> it's needless distraction. Maybe it's just me, but whenever I read
>> references to them I keep waiting for the cryptography angle to be
>> introduced. None of the uses in our documentation reflect that canonical
>> usage.
>
> It's probably not just you, but the vast majority of readers are
> likely not aware of any cryptographic reference.

I find it surprising that anyone would be upset that the names Alice and
Bob were being used in a non cryptographic context.

>> There's also just weird things in our documentation fixed by this
>> series, such as referring to a random file tracked by git as "bob"
>> instead of the more obvious "file.txt".
>
> OK, _that_ I agree it's unequivocally an improvement.

Yea, a file probably shouldn't be called bob... I would probably have
gone with "foo.txt" ( but file.txt is just fine too ).


  reply	other threads:[~2021-06-17 15:54 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 ` [PATCH 5/6] doc: replace "alice" and "bob" with "jdoe" and "msmith" Ævar Arnfjörð Bjarmason
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 [this message]
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=87pmwkh4he.fsf@vps.thesusis.net \
    --to=phill@thesusis.net \
    --cc=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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.