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

Re: [PATCH v2 3/4] doc: git-add: make explanation less dry

From
Julia Evans <julia@jvns.ca>
Date
Aug 19, 2025, 12:57 UTC
Message-ID
<007dd7bb-352e-4682-8ca2-8256d9a47e07@app.fastmail.com>
In-Reply-To
<xmqqsehspdtr.fsf@gitster.g>
> Yes, you can lose your novice status and it is hard to take it back
> ;-)  I agree with you that the next best thing you can do is to see
> how well folks who still have that status do.

I've returned with some data! I got feedback on the `git-add` man page from 13 Git users. It's a group of pretty experienced users: half of them have been using Git for 5-10 years, and about half for 10+ years. Even though there are no "novices" here, they still provided useful feedback about what's confusing.

Here's what I took away from the feedback and a summary of the comments. First, what I took away:

* The term "index" is hard to understand even for very experienced Git users,
  and even for some users who say that they are extremely comfortable with Git.
* The second sentence in the man page is too long and hard to parse.
* The "(quote your globs before the shell)" phrasing is confusing.
* I thought mentioning that you can use `git reset` to undo a `git add` was a
  good idea.
* Leaving something similar to the existing phrasing around "snapshot" seems
  fine, nobody in this group was confused, though of course this is a group
  of people who already understand how `git add` works.

Here's my summary of the comments on the existing man page. I collected them using this little tool I built: https://text-feedback.wizardzines.com/git-add/. I'm happy to also figure out how to best share the "raw" comments if folks would find that helpful. I've quoted the current man page text for context.

Show 5 quoted lines
> This command updates the index using the current content found in the working
> tree, to prepare the content staged for the next commit. It typically adds the
> current content of existing paths as a whole, but with some options it can also
> be used to add content with only part of the changes made to the working tree
> files applied, or remove paths that do not exist in the working tree anymore.

This was the paragraph with the most "this is confusing" comments. Here are the main themes:

1. 7 people (more than half) said that they find the term "index" confusing. A
   few example quotes:
   * "updates the index" sounds like it increments something"
   * "Is the index not just the content that is staged for commit? Do I as an
	 end user need to care about the difference? I've not heard the staged
	 content referred to as the index before, even in git command outputs."
2. 3 people said the second sentence is too long and hard to parse
3. 2 people said that "It *typically* adds the current content of existing
   paths" is confusing (What's meant by "typically"? When does it not do that?
   is this referring to git add -A?)
Show 5 quoted lines
> The "index" holds a snapshot of the content of the working tree, and it is
> this snapshot that is taken as the contents of the next commit. Thus after
> making any changes to the working tree, and before running the commit
> command, you must use the add command to add any new or modified
> files to the index.

Nobody said they were confused by this, other than continued confusion around the term "index", like:

* "Why quotes around "index" here but not when I first encounter the word
  index?"
* "I'm guessing index is used through git man pages and staging area is a newer
  way of saying this 🤔"
* "Can we just say staging area? I don't think of adding changes to the "index""
Comments not related to the term "index":
* "Would prefer something more direct like "git lets you gradually build the
  contents of the next commit by adding things to the staging area...""
* "I wish this came first in the description."
* One person said they appreciated "you must use the add command [after making
  any changes]", since that confused them when they started using git
> This command can be performed multiple times before a commit. It only adds the
> content of the specified file(s) at the time the add command is run; if you
> want subsequent changes included in the next commit, then you must run git add
> again to add the new content to the index.
No comments other than "Can be improved to be more clear."
> Ignored files reached by directory recursion or filename globbing performed
> by Git (quote your globs before the shell)

4 people did not understand what "(quote your globs before the shell)" meant. ("Does it mean that I need to escape glob quotation marks?").

> The git status command can be used to obtain a summary of which files have
> changes that are staged for the next commit.

Nobody said they were confused by this. One person said they were happy it was mentioned, and one person suggested replacing "obtain" with "get".

Things people said they learned from the man page:
1. "I did not know that the globs would be treated potentially differently if
   expanded by the shell before getting to git."
2. "I never knew git could do globbing."
3. "I didn't know you could remove paths with add"
Things people suggested adding:
1. "This should also document how to undo the effects of "git add". I'm always
   confused between how best to do so between "git restore" and "git reset"."
Previous: Junio C HamanoNext: Jean-Noël AVILA
Message 39 of 59 in “doc: git-add: clarify DESCRIPTION section”
  1. 0/5 doc: git-add: clarify DESCRIPTION sectionJulia Evans via GitGitGadget, Aug 12, 2025
  2. 1/5 doc: git-add: remove options from SYNOPSISJulia Evans via GitGitGadget, Aug 12, 2025
  3. Junio C HamanoAug 12, 2025
  4. Julia EvansAug 13, 2025
  5. Jean-Noël AVILAAug 13, 2025
  6. 2/5 doc: git-add: start man page with an exampleJulia Evans via GitGitGadget, Aug 12, 2025
  7. Junio C HamanoAug 12, 2025
  8. Julia EvansAug 12, 2025
  9. Junio C HamanoAug 12, 2025
  10. Julia EvansAug 12, 2025
  11. D. Ben KnobleAug 13, 2025
  12. Junio C HamanoAug 14, 2025
  13. Julia EvansAug 14, 2025
  14. Junio C HamanoAug 15, 2025
  15. 3/5 doc: git-add: simplify discussion of ignored filesJulia Evans via GitGitGadget, Aug 12, 2025
  16. D. Ben KnobleAug 13, 2025
  17. 4/5 doc: git-add: make explanation less dryJulia Evans via GitGitGadget, Aug 12, 2025
  18. 5/5 doc: git-add: explain inconsistent terminologyJulia Evans via GitGitGadget, Aug 12, 2025
  19. Chris TorekAug 12, 2025
  20. Junio C HamanoAug 12, 2025
  21. Julia EvansAug 12, 2025
  22. 0/4 doc: git-add: clarify DESCRIPTION sectionJulia Evans via GitGitGadget, Aug 13, 2025
  23. 1/4 doc: git-add: start man page with an exampleJulia Evans via GitGitGadget, Aug 13, 2025
  24. Junio C HamanoAug 15, 2025
  25. Jean-Noël AVILAAug 15, 2025
  26. Junio C HamanoAug 15, 2025
  27. Jean-Noël AVILAAug 17, 2025
  28. Julia EvansAug 19, 2025
  29. 2/4 doc: git-add: simplify discussion of ignored filesJulia Evans via GitGitGadget, Aug 13, 2025
  30. D. Ben KnobleAug 14, 2025
  31. Junio C HamanoAug 14, 2025
  32. 3/4 doc: git-add: make explanation less dryJulia Evans via GitGitGadget, Aug 13, 2025
  33. Junio C HamanoAug 14, 2025
  34. Julia EvansAug 15, 2025
  35. D. Ben KnobleAug 15, 2025
  36. Junio C HamanoAug 15, 2025
  37. D. Ben KnobleAug 16, 2025
  38. Junio C HamanoAug 15, 2025
  39. Julia EvansAug 19, 2025
  40. Jean-Noël AVILAAug 21, 2025
  41. 4/4 doc: git-add: explain inconsistent terminologyJulia Evans via GitGitGadget, Aug 13, 2025
  42. Junio C HamanoAug 14, 2025
  43. Julia EvansAug 19, 2025
  44. 0/3 doc: git-add: clarify DESCRIPTION sectionJulia Evans via GitGitGadget, Aug 19, 2025
  45. 1/3 Git 2.51Junio C Hamano via GitGitGadget, Aug 19, 2025
  46. rsbecker@nexbridge.comAug 19, 2025
  47. Junio C HamanoAug 19, 2025
  48. D. Ben KnobleAug 19, 2025
  49. Julia EvansAug 19, 2025
  50. rsbecker@nexbridge.comAug 19, 2025
  51. 3/3 doc: git-add: simplify discussion of ignored filesJulia Evans via GitGitGadget, Aug 19, 2025
  52. Junio C HamanoAug 21, 2025
  53. 2/3 doc: git-add: clarify intro & add an exampleJulia Evans via GitGitGadget, Aug 19, 2025
  54. Junio C HamanoAug 21, 2025
  55. Julia EvansAug 22, 2025
  56. 0/2 doc: git-add: clarify DESCRIPTION sectionJulia Evans via GitGitGadget, Aug 29, 2025
  57. 1/2 doc: git-add: clarify intro & add an exampleJulia Evans via GitGitGadget, Aug 29, 2025
  58. 2/2 doc: git-add: simplify discussion of ignored filesJulia Evans via GitGitGadget, Aug 29, 2025
  59. Junio C HamanoAug 29, 2025

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.