From: Junio C Hamano <gitster@pobox.com>
To: Jeff King <peff@peff.net>
Cc: Matthieu Moy <Matthieu.Moy@grenoble-inp.fr>,
Samuel GROOT <samuel.groot@ensimag.grenoble-inp.fr>,
Tom Russello <tom.russello@grenoble-inp.org>,
git@vger.kernel.org, erwan.mathoniere@ensimag.grenoble-inp.fr,
jordan.de-gea@ensimag.grenoble-inp.fr, stefan@sevenbyte.org,
jrnieder@gmail.com, rybak.a.v@gmail.com
Subject: Re: [RFC/PATCH] Formatting variables in the documentation
Date: Thu, 26 May 2016 09:18:17 -0700 [thread overview]
Message-ID: <xmqqmvncyera.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20160526043607.GB6756@sigill.intra.peff.net> (Jeff King's message of "Thu, 26 May 2016 00:36:07 -0400")
Jeff King <peff@peff.net> writes:
> On Mon, May 23, 2016 at 07:57:43PM +0200, Matthieu Moy wrote:
>
>> Samuel GROOT <samuel.groot@ensimag.grenoble-inp.fr> writes:
>>
>> > Since 2.8.3 was out recently, we could flip MAN_BOLD_LITERAL on by
>> > default for this cycle to shake out problems as Jeff King suggested
>> > [2].
>>
>> 2.8.3 was a bufix release, and flipping a controversial flag should
>> clearly not be done on a bugfix release. So, in this context, "beginning
>> of a cycle" means after a x.y.0 release.
>>
>> Anyway, a patch enabling MAN_BOLD_LITERAL by default would need to cook
>> in pu and next as any other patches, so the time when the patch is sent
>> does not really matter.
>
> Yeah, I think a reasonable plan is:
>
> 1. Somebody produces a patch flipping the default. The patch is
> trivial, but the commit message should tell why, and try to dig up
> any possible problems we might see (e.g., why wasn't this the
> default? Particular versions of tools? Some platforms?)
"git log -SBOLD_LITERAL Documentation/" tells me that it's not like
we had this on by default sometime in the past and then we flipped
the default back in response to some problems (which I forgot
about).
I just re-read the two iterations that introduced BOLD_LITERAL:
* http://news.gmane.org/find-root.php?message_id=<1237881866-5497-1-git-send-email-chris_johnsen@pobox.com>
* http://news.gmane.org/find-root.php?message_id=<1238136245-22853-1-git-send-email-chris_johnsen@pobox.com>
There was no particular "caveat" raised there to recommend against
using this on particular versions of tools or platforms. It was
inertia that has kept the new optional feature "optional".
> 2. Assuming no problems, Junio merges the patch to "next". We get
> any reports of issues from people using "next" day-to-day.
So I can do these steps myself up to this point. After waiting for
a few days to see if somebody else with better memory tells me what
I forgot, perhaps.
> 3. Assuming no problems, Junio merges to "master". We hit more people
> (who build from master). And also it would be part of the
> pre-generated pages that Junio ships, so we might get reports
> there.
>
> 4. Eventually it's released. We hope to get no problem reports there,
> though it _does_ hit a wider audience at that point.
>
> Steps 1 and 2 can happen now. As we are in the -rc cycle right now,
> probably step 3 would happen post-v2.9. But there's no reason not to
> start the clock ticking now.
>
> -Peff
next prev parent reply other threads:[~2016-05-26 16:18 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-18 15:58 [RFC/PATCH] Formatting variables in the documentation Tom Russello
2016-05-18 18:15 ` Jeff King
2016-05-23 16:00 ` Samuel GROOT
2016-05-23 17:57 ` Matthieu Moy
2016-05-26 4:36 ` Jeff King
2016-05-26 16:18 ` Junio C Hamano [this message]
2016-05-26 16:23 ` Jeff King
2016-05-26 16:37 ` Junio C Hamano
2016-05-26 16:39 ` Jeff King
2016-05-31 16:20 ` [PATCH] Documentation: bold literals in man Erwan Mathoniere
2016-06-03 22:08 ` [PATCH v2] Documentation more consistent Tom Russello
2016-06-03 22:08 ` [PATCH v2 1/3] Clearer rule about formatting literals Tom Russello
2016-06-03 22:08 ` [PATCH v2 2/3] Change environment variables format Tom Russello
2016-06-03 22:08 ` [PATCH v2 3/3] Change configuration " Tom Russello
2016-06-03 22:42 ` [PATCH v2] Documentation more consistent Junio C Hamano
2016-06-06 10:09 ` [PATCH v3] " Tom Russello
2016-06-06 10:09 ` [PATCH v3 1/3] doc: clearer rule about formatting literals Tom Russello
2016-06-06 13:36 ` Matthieu Moy
2016-06-06 13:42 ` Matthieu Moy
2016-06-06 15:38 ` Tom Russello
2016-06-06 10:09 ` [PATCH v3 2/3] doc: change environment variables format Tom Russello
2016-06-06 14:08 ` Matthieu Moy
2016-06-06 16:34 ` Tom Russello
2016-06-06 10:09 ` [PATCH v3 3/3] doc: change configuration " Tom Russello
2016-06-06 14:09 ` Matthieu Moy
2016-06-07 22:35 ` [PATCH v4 0/3] Documentation more consistent Tom Russello
2016-06-07 22:35 ` [PATCH v4 1/3] doc: clearer rule about formatting literals Tom Russello
2016-06-07 22:35 ` [PATCH v4 2/3] doc: change environment variables format Tom Russello
2016-06-07 22:35 ` [PATCH v4 3/3] doc: more consistency in " Tom Russello
2016-06-08 6:26 ` Matthieu Moy
2016-06-08 17:27 ` Tom Russello
2016-06-08 6:56 ` Johannes Sixt
2016-06-08 8:12 ` Matthieu Moy
2016-06-08 17:23 ` [PATCH v4 4/3] doc: change configuration " Tom Russello
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=xmqqmvncyera.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox.com \
--cc=Matthieu.Moy@grenoble-inp.fr \
--cc=erwan.mathoniere@ensimag.grenoble-inp.fr \
--cc=git@vger.kernel.org \
--cc=jordan.de-gea@ensimag.grenoble-inp.fr \
--cc=jrnieder@gmail.com \
--cc=peff@peff.net \
--cc=rybak.a.v@gmail.com \
--cc=samuel.groot@ensimag.grenoble-inp.fr \
--cc=stefan@sevenbyte.org \
--cc=tom.russello@grenoble-inp.org \
/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).