Re: [PATCH 4/5] doc: use .adoc extension for AsciiDoc files

From: brian m. carlson <sandals@crustytoothpaste.net>
Date: Feb 7, 2025, 22:54 UTC
Message-ID: <Z6aPNL0R99FL2_2k@tapette.crustytoothpaste.net>
In-Reply-To: <xmqqtt95fx62.fsf@gitster.g>

On 2025-02-07 at 18:05:09, Junio C Hamano wrote:

> I was wondering why we remove SubmittingPatches.txt with "make
> clean" there the other day.  There is a Documentation/Makefile
> target to create %.txt from % applied for SubmittingPatches.

Some time back I converted SubmittingPatches to AsciiDoc with a variety of anchors because it's easier to link to the portions of the document from the website. For example, many projects want to use our advice to use logically separate commits or to describe changes well, and it's much easier (and honours the license better) to just link to our documentation than to copy it elsewhere.

Show 8 quoted lines

> > for CodingGuidelines, though. (We also package
> > ReviewingGuidelines.{html,txt}, but it has a .txt extension.)
> 
> Thanks for noticing an annoying inconsistency that must be rectified
> independent of brian's topic to help it easier for Editors to
> identify the files that are written in AsciiDoc.  If we are shipping
> documents that are exclusively meant for Git developers, we should
> be shipping all of them together.

I agree.  My apologies for missing that.

-- 
brian m. carlson (they/them or he/him)
Toronto, Ontario, CA