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

[PATCH 0/4] Additional FAQ entries

From
brian m. carlson <sandals@crustytoothpaste.net>
Date
Oct 20, 2021, 01:06 UTC
Message-ID
<20211020010624.675562-1-sandals@crustytoothpaste.net>

This series introduces some additional Git FAQ entries on various topics. They are all things I've seen in my professional life or on Stack Overflow, and I tire of repeating myself, so I've written documentation.

The first covers monorepos. It tries to strike a neutral tone and indicate that we're improving support for them, but it does note that many large users still run into scale problems, especially at a point where it's inconvenient to change[0]. I do frequently see these problems on some scale, so my hope is that we can make users consider this case carefully. I have mentioned only scalability features which are released and reasonably mature, but if I've missed any that I should have mentioned, please let me know, since I don't always follow the list as closely as I should.

The second covers proxies, in the generic sense of that word. It instructs users how to use an HTTP proxy intentionally, and it also notes that any proxy which buffers or tampers with the data will break Git. I frequently see users with TLS middleboxes or antivirus software other than the Windows default with breakage on Stack Overflow[1], and we see them occasionally on the list as well. Because these tools are known to cause both functionality and security problems, both for Git and in general[2][3][4], we explicitly recommend against them here. I am happy to provide additional citations to Project Zero, various bug reports, security experts, and the cryptographic literature if folks have doubts about whether this is the right approach.

The third should be relatively uncontroversial. We discuss using eol attributes in gitattributes, which we had neglected to cover before, and illustrate their utility. In addition, we fix a reference.

The fourth and final patch covers syncing working trees. An earlier version of this patch has come up on the list before and I had never sent a rerolled version. I realize that we don't love that people want to do this, but users are currently using cloud syncing services and experiencing data loss, so I figured we'd better tell them how to do it as safely as they can so they stop losing data.

I realize that folks are busy with the Contributor Summit and other things, and so of course reviews may be delayed. I've tried to pick people who I think will have relevant interest in each of these areas, but of course feedback from anyone is welcome.

[0] For instance, the Windows repo.
[1] In addition to users for whom SSH "magically" works when HTTPS does
    not, many of which are likely the same issue.
[2] https://robert.ocallahan.org/2017/01/disable-your-antivirus-software-except.html
[3] https://twitter.com/parityzero/status/826489070310207489
[4] https://groups.google.com/g/mozilla.dev.platform/c/Bh8U0DLHrCc
brian m. carlson (4):
  gitfaq: add advice on monorepos
  gitfaq: add documentation on proxies
  gitfaq: give advice on using eol attribute in gitattributes
  gitfaq: add entry about syncing working trees
 Documentation/gitfaq.txt | 107 ++++++++++++++++++++++++++++++++++++---
 1 file changed, 101 insertions(+), 6 deletions(-)
Next: brian m. carlson
Message 1 of 30 in “Additional FAQ entries”
  1. 0/4 Additional FAQ entriesbrian m. carlson, Oct 20, 2021
  2. 3/4 gitfaq: give advice on using eol attribute in gitattributesbrian m. carlson, Oct 20, 2021
  3. Eric SunshineOct 20, 2021
  4. brian m. carlsonOct 20, 2021
  5. Johannes SchindelinOct 20, 2021
  6. brian m. carlsonOct 20, 2021
  7. Johannes SchindelinOct 21, 2021
  8. 4/4 doc: add a FAQ entry about syncing working treesbrian m. carlson, Oct 20, 2021
  9. Bagas SanjayaOct 20, 2021
  10. Philip OakleyOct 20, 2021
  11. Ævar Arnfjörð BjarmasonOct 20, 2021
  12. brian m. carlsonOct 21, 2021
  13. Ævar Arnfjörð BjarmasonOct 21, 2021
  14. 4/4 gitfaq: add entry about syncing working treesbrian m. carlson, Oct 20, 2021
  15. Eric SunshineOct 20, 2021
  16. brian m. carlsonOct 20, 2021
  17. Johannes SchindelinOct 20, 2021
  18. 1/4 gitfaq: add advice on monoreposbrian m. carlson, Oct 20, 2021
  19. Bagas SanjayaOct 20, 2021
  20. Ævar Arnfjörð BjarmasonOct 20, 2021
  21. brian m. carlsonOct 20, 2021
  22. Johannes SchindelinOct 20, 2021
  23. Philip OakleyOct 20, 2021
  24. brian m. carlsonOct 20, 2021
  25. Philip OakleyOct 25, 2021
  26. 2/4 gitfaq: add documentation on proxiesbrian m. carlson, Oct 20, 2021
  27. Johannes SchindelinOct 20, 2021
  28. brian m. carlsonOct 20, 2021
  29. Junio C HamanoOct 20, 2021
  30. brian m. carlsonOct 20, 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.