From: Samuel GROOT <samuel.groot@ensimag.grenoble-inp.fr>
To: Jeff King <peff@peff.net>, Tom Russello <tom.russello@grenoble-inp.org>
Cc: git@vger.kernel.org, matthieu.moy@grenoble-inp.fr,
erwan.mathoniere@ensimag.grenoble-inp.fr,
jordan.de-gea@ensimag.grenoble-inp.fr, gitster@pobox.com,
stefan@sevenbyte.org, jrnieder@gmail.com, rybak.a.v@gmail.com
Subject: Re: [RFC/PATCH] Formatting variables in the documentation
Date: Mon, 23 May 2016 18:00:26 +0200 [thread overview]
Message-ID: <b06231ac-b100-2565-3bf7-99f268014788@ensimag.grenoble-inp.fr> (raw)
In-Reply-To: <20160518181500.GD5796@sigill.intra.peff.net>
Some people have suggested to standardize documentation's formatting to
make it more consistent.
[1] 2015-04-29 20:13:53 GMT, Junio C Hamano wrote:
> Interesting. What I happen to use when populating the git-manpages
> repository would have wider impact to the users, as I hear that some
> (or many) distros just package whatever I have there. I do not mind
> enabling it on my end if that gives us more readable rendition.
[2] On 2015-04-29 20:32:47, Jeff King wrote:
> I think it's probably fine and a positive change, but one never knows. I
> guess distros don't package what you ship until you actually tag a
> release, so it would be OK to start doing so during a cycle to shake out
> any problems (and in fact preferable, as anybody who follows "master"
> using "make install-man-quick" would get it early and be able to make a
> report).
>
> If we are doing that, it would make sense to flip MAN_BOLD_LITERAL on by
> default during that same cycle, so we could get reports from people who
> build the manpages from source.
[3] On 2015-11-13 05:45:05, Jeff King wrote:
> If we want to move to backticks, we probably want to also turn on
> MAN_BOLD_LITERAL by default, or it's a step backwards for some folks.
The question is about flipping MAN_BOLD_LITERAL by default or not.
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].
Another option could be testing if the system does support bold literal
and flipping it on or off accordingly, but I don't know exactly where
that could be done.
next prev parent reply other threads:[~2016-05-23 16:09 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 [this message]
2016-05-23 17:57 ` Matthieu Moy
2016-05-26 4:36 ` Jeff King
2016-05-26 16:18 ` Junio C Hamano
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=b06231ac-b100-2565-3bf7-99f268014788@ensimag.grenoble-inp.fr \
--to=samuel.groot@ensimag.grenoble-inp.fr \
--cc=erwan.mathoniere@ensimag.grenoble-inp.fr \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jordan.de-gea@ensimag.grenoble-inp.fr \
--cc=jrnieder@gmail.com \
--cc=matthieu.moy@grenoble-inp.fr \
--cc=peff@peff.net \
--cc=rybak.a.v@gmail.com \
--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).