git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Todd Zullinger <tmz@pobox.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Son Luong Ngoc" <sluongng@gmail.com>,
	"Shourya Shukla" <shouryashukla.oo@gmail.com>,
	"Elijah Newren" <newren@gmail.com>,
	"brian m. carlson" <sandals@crustytoothpaste.net>,
	"Martin Ågren" <martin.agren@gmail.com>,
	git@vger.kernel.org
Subject: Re: What's cooking in git.git (May 2020, #08; Sun, 24)
Date: Mon, 25 May 2020 13:27:08 -0400	[thread overview]
Message-ID: <20200525172708.GT6611@pobox.com> (raw)
In-Reply-To: <xmqqh7w4pulj.fsf@gitster.c.googlers.com>

Hi,

Junio C Hamano wrote:
> Git 2.27-rc2 will be tagged soon, but most of the topics planned for
> it are already in 'master'.

There's a minor issue in the ss/faq-ignore topic which
breaks the doc build on CentOS/ RHEL 6 that was mentioned by
Son Luong Ngoc¹.  The "." in the anchor text causes an issue
for the older doc toolchain on these systems.

I included a simple patch for that in a reply².  I haven't
seen any discussion on it one way or another.  At the risk
of pestering, I thought I'd mention it in case it had just
flown under everyone's radar during this busy time.

On one hand, the doc build toolchain on CentOS / RHEL 6 is
old and those systems will be EOL at the end of November.
So we might find it acceptable to stop supporting the doc
build there.

On the other hand, the fix/workaround is quite trivial and
nearly imperceptible to readers of the documentation.  The
problematic "." in ".gitiginore" only appears in the anchor
link for HTML viewers or in the plain text for readers of
the .txt file:

    [[files-in-.gitignore-are-tracked]]

vs.

    [[files-in-gitignore-are-tracked]]

I'm not sure there's enough value in keeping the "." in this
case to justify breaking the doc build for users stuck on an
old CentOS / RHEL 6 system.

I think the risk of applying the patch is sufficiently low
that it would be worth including in 2.27.0.  That is, unless
there is a strong opinion that the "." is quite useful or
that even low effort isn't worth taking to support such an
old doc toolchain.

¹ https://lore.kernel.org/git/CAL3xRKdwOASiGys+7Uu_OA5kBPrTdAURfEw3UQ+rguTXT+C6JQ@mail.gmail.com/
² https://lore.kernel.org/git/20200519045301.GY24220@pobox.com/

Thanks,

-- 
Todd

  parent reply	other threads:[~2020-05-25 17:27 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-25  3:22 What's cooking in git.git (May 2020, #08; Sun, 24) Junio C Hamano
2020-05-25 14:55 ` Elijah Newren
2020-05-25 16:22   ` Junio C Hamano
2020-05-25 17:27 ` Todd Zullinger [this message]
2020-05-25 17:53   ` brian m. carlson
2020-05-25 18:13     ` Junio C Hamano
2020-05-26 16:01       ` Todd Zullinger

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=20200525172708.GT6611@pobox.com \
    --to=tmz@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=martin.agren@gmail.com \
    --cc=newren@gmail.com \
    --cc=sandals@crustytoothpaste.net \
    --cc=shouryashukla.oo@gmail.com \
    --cc=sluongng@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).