From: "brian m. carlson" <sandals@crustytoothpaste•net>
To: Jeff King <peff@peff•net>
Cc: Jakub Narebski <jnareb@gmail•com>,
git@vger•kernel.org, Junio C Hamano <gitster@pobox•com>
Subject: Re: [PATCH v3 3/4] doc: dissuade users from trying to ignore tracked files
Date: Mon, 4 Nov 2019 23:52:42 +0000 [thread overview]
Message-ID: <20191104235242.GD32531@camp.crustytoothpaste.net> (raw)
In-Reply-To: <20191104222416.GB22367@sigill.intra.peff.net>
[-- Attachment #1: Type: text/plain, Size: 1419 bytes --]
On 2019-11-04 at 22:24:16, Jeff King wrote:
> On Sun, Nov 03, 2019 at 06:59:08PM +0000, brian m. carlson wrote:
>
> > > I would really like to see a simple example of such template, so that
> > > even people who are unfamiliar with Ruby's ERB can think of equivalent
> > > solution for their language or toolchain of choice.
> >
> > I hesitated to mention ERB, but I wasn't sure that folks would know what
> > we meant by a "templating mechanism". The reason I had chosen to
> > mention it is that someone could search for "Ruby ERB" and find out what
> > it looked like and then look for an option in their own language.
>
> I don't mind what is here, but I might even suggest going slightly in
> the opposite direction. Say something like:
>
> For example, you the repository can include a sample config file that
> can then be copied into the ignored name and modified.
>
> which points people in the right direction without giving specifics. But
> if you did want to go further, you can then say:
>
> The repository can even include a script to treat the sample file as a
> template, modifying and copying it automatically (e.g., a Ruby script
> using an ERB template).
>
> or something.
I think this is a nice change. It summarizes the proposed solution
without needing to be specific.
--
brian m. carlson: Houston, Texas, US
OpenPGP: https://keybase.io/bk2204
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 868 bytes --]
next prev parent reply other threads:[~2019-11-04 23:52 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-02 19:26 [PATCH v3 0/4] Documentation for common user misconceptions brian m. carlson
2019-11-02 19:26 ` [PATCH v3 1/4] doc: move author and committer information to git-commit(1) brian m. carlson
2019-11-03 11:13 ` Jakub Narebski
2019-11-04 22:18 ` Jeff King
2019-11-06 1:55 ` Junio C Hamano
2019-11-02 19:26 ` [PATCH v3 2/4] doc: provide guidance on user.name format brian m. carlson
2019-11-03 13:13 ` Jakub Narebski
2019-11-03 19:23 ` brian m. carlson
2019-11-02 19:26 ` [PATCH v3 3/4] doc: dissuade users from trying to ignore tracked files brian m. carlson
2019-11-02 20:14 ` rsbecker
2019-11-03 15:46 ` Jakub Narebski
2019-11-03 15:04 ` Jakub Narebski
2019-11-03 18:59 ` brian m. carlson
2019-11-03 19:40 ` Jakub Narebski
2019-11-03 21:46 ` brian m. carlson
2019-11-05 0:21 ` Jakub Narebski
2019-11-04 22:24 ` Jeff King
2019-11-04 23:52 ` brian m. carlson [this message]
2019-11-02 19:26 ` [PATCH v3 4/4] docs: mention when increasing http.postBuffer is valuable brian m. carlson
2019-11-04 22:26 ` [PATCH v3 0/4] Documentation for common user misconceptions Jeff King
2019-11-06 1:58 ` Junio C Hamano
2019-11-06 2:19 ` brian m. carlson
2019-11-06 3:15 ` Junio C Hamano
2020-01-16 21:08 ` Emily Shaffer
2020-01-16 23:35 ` brian m. carlson
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191104235242.GD32531@camp.crustytoothpaste.net \
--to=sandals@crustytoothpaste$(echo .)net \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=jnareb@gmail$(echo .)com \
--cc=peff@peff$(echo .)net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox