git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 0/6] doc: replace "alice" and "bob" examples

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Jun 17, 2021, 20:51 UTC
Message-ID
<8735tg5hv7.fsf@evledraar.gmail.com>
In-Reply-To
<87pmwkh4he.fsf@vps.thesusis.net>
On Thu, Jun 17 2021, Phillip Susi wrote:
Show 21 quoted lines
> 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.

Who's upset? Not the author of this patch series, as noted in 1/6 I just think it makes for less confusing reading, since Alice & Bob in particular have implicit meanings you might guess at[1], and aside from that I think it simplifies the example the guide is getting at [2].

Show 8 quoted lines
>>> 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 ).

Git's documentation is read by all sorts of audiences, "foo" and "bar" are programmer jargon not obvious to everyone. I wouldn't say don't use it at all, but when a self-descriptive alternative such as file.txt or whatever works perfectly fine as in the case changed in this series, it's better to go with that.

1. http://lore.kernel.org/git/patch-1.6-abbb5b9ba13-20210615T161330Z-avarab@gmail.com
2. https://lore.kernel.org/git/875yyc5i6x.fsf@evledraar.gmail.com/
Previous: Phillip SusiNext: Junio C Hamano
Message 19 of 24 in “doc: replace "alice" and "bob" examples”
  1. 0/6 doc: replace "alice" and "bob" examplesÆvar Arnfjörð Bjarmason, Jun 15, 2021
  2. 1/6 gittutorial doc: replace "alice" and "bob" with "you" and "www-data"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  3. Bagas SanjayaJun 16, 2021
  4. Junio C HamanoJun 16, 2021
  5. Felipe ContrerasJun 16, 2021
  6. Ævar Arnfjörð BjarmasonJun 17, 2021
  7. 2/6 gitcvs-migration doc: replace "alice" and "bob" with "you" and "www-data"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  8. Bagas SanjayaJun 16, 2021
  9. 3/6 daemon doc + code comments: reword "alice" exampleÆvar Arnfjörð Bjarmason, Jun 15, 2021
  10. 4/6 fast-import doc: change "bob" in an example to "file.txt"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  11. 5/6 doc: replace "alice" and "bob" with "jdoe" and "msmith"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  12. 6/6 pack-protocol doc: use "www-data" in place of "alice"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  13. Robert P. J. DayJun 15, 2021
  14. Ævar Arnfjörð BjarmasonJun 15, 2021
  15. Felipe ContrerasJun 15, 2021
  16. Ævar Arnfjörð BjarmasonJun 15, 2021
  17. Felipe ContrerasJun 16, 2021
  18. Phillip SusiJun 17, 2021
  19. Ævar Arnfjörð BjarmasonJun 17, 2021
  20. Junio C HamanoJun 16, 2021
  21. Robert P. J. DayJun 16, 2021
  22. Jeff KingJun 16, 2021
  23. Felipe ContrerasJun 16, 2021
  24. Randall S. BeckerJun 16, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.