From: "brian m. carlson" <sandals@crustytoothpaste.net>
To: <git@vger.kernel.org>
Cc: Emily Shaffer <emilyshaffer@google.com>,
Junio C Hamano <gitster@pobox.com>,
Shourya Shukla <shouryashukla.oo@gmail.com>
Subject: [PATCH v2 0/1] FAQ for common user questions
Date: Wed, 25 Mar 2020 01:34:33 +0000 [thread overview]
Message-ID: <20200325013434.219775-1-sandals@crustytoothpaste.net> (raw)
Git is an enormously flexible and powerful piece of software, but many
people find it confusing and hard to use. This patch introduces a FAQ
to address some common user questions and hopefully make it easier.
I know there are some plans to add additional entries to this. I
propose we tack them on as additional patches, and if I need to reroll
this again, I can pick them up as part of the series, unless someone
has strong opinions about doing things differently.
Changes from v1:
* Fix various indentation issues.
* Avoid using "some people", except to state that "some people find `vi`
difficult to use", preferring to use language addressing
misconceptions more directly.
* Add "erroneously" to "This is often suggested" to avoid users
accidentally doing what we recommend against.
* Attempt to come up with a better way to describe a personal name,
using Junio as an example.
brian m. carlson (1):
docs: add a FAQ
Documentation/Makefile | 1 +
Documentation/gitfaq.txt | 337 +++++++++++++++++++++++++++++++++++++++
2 files changed, 338 insertions(+)
create mode 100644 Documentation/gitfaq.txt
next reply other threads:[~2020-03-25 1:35 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-25 1:34 brian m. carlson [this message]
2020-03-25 1:34 ` [PATCH v2] docs: add a FAQ brian m. carlson
2020-03-25 6:23 ` Martin Ågren
2020-03-25 11:03 ` brian m. carlson
2020-03-25 18:03 ` Martin Ågren
2020-03-25 6:10 ` [PATCH v2 0/1] FAQ for common user questions Junio C Hamano
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200325013434.219775-1-sandals@crustytoothpaste.net \
--to=sandals@crustytoothpaste.net \
--cc=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=shouryashukla.oo@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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).