[PATCH v2 0/3] Documentation for common user misconceptions

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



This series includes three patches that update the documentation to
address common user misconceptions.

The first patch has seen the list before, which is why this is now v2.
It addresses the attempt to use "user.name" as a username for
$GIT_HOSTING_SERVICE instead of a person's personal name.

The second patch is new, and addresses a common desire (as seen on Stack
Overflow) to ignore changes to tracked files.  If folks want, I can add
a paragraph to expand on the common use cases (IDE configuration and
config files) and offer general suggestions for them; if not, we can
leave the patch as it stands.

The final patch, also new, addresses a common source of bad advice in
response to any push problem: raise http.postBuffer.  The patch
indicates why this is almost never an effective solution, so explain
what the option really does and that it is not a panacea.

We probably should have a document such as a FAQ that addresses these
and other common issues, both to make Git more approachable and less
scary for newcomers, and provide accurate information for situations
like these.  I've started on some drafts of such a FAQ, but have gotten
side-tracked with other things and haven't made much progress.

In the mean time, it's my hope that by providing documentation on these
issues, we can point people to it and encourage people to solutions that
solve their problems instead of having them receive incorrect
information which is not effective.

Changes from v1:
* Remove parenthetical which was confusing.
* Add two more patches.

brian m. carlson (3):
  doc: provide guidance on user.name format
  doc: dissuade users from trying to ignore tracked files
  docs: mention when increasing http.postBuffer is valuable

 Documentation/config/http.txt      |  7 +++++++
 Documentation/git-commit-tree.txt  |  6 ++++++
 Documentation/git-update-index.txt | 10 ++++++++++
 3 files changed, 23 insertions(+)




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux