From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS31976 209.132.180.0/23 X-Spam-Status: No, score=-3.1 required=3.0 tests=AWL,BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI, RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_NONE,URIBL_SBL, URIBL_SBL_A shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by dcvr.yhbt.net (Postfix) with ESMTP id 028A81F466 for ; Tue, 28 Jan 2020 07:33:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1725848AbgA1Hdm (ORCPT ); Tue, 28 Jan 2020 02:33:42 -0500 Received: from cloud.peff.net ([104.130.231.41]:46060 "HELO cloud.peff.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with SMTP id S1725776AbgA1Hdm (ORCPT ); Tue, 28 Jan 2020 02:33:42 -0500 Received: (qmail 7450 invoked by uid 109); 28 Jan 2020 07:33:41 -0000 Received: from Unknown (HELO peff.net) (10.0.1.2) by cloud.peff.net (qpsmtpd/0.94) with SMTP; Tue, 28 Jan 2020 07:33:41 +0000 Authentication-Results: cloud.peff.net; auth=none Received: (qmail 5082 invoked by uid 111); 28 Jan 2020 07:41:12 -0000 Received: from coredump.intra.peff.net (HELO sigill.intra.peff.net) (10.0.0.2) by peff.net (qpsmtpd/0.94) with (TLS_AES_256_GCM_SHA384 encrypted) ESMTPS; Tue, 28 Jan 2020 02:41:12 -0500 Authentication-Results: peff.net; auth=none Date: Tue, 28 Jan 2020 02:33:40 -0500 From: Jeff King To: Heba Waly Cc: Johannes Sixt , Heba Waly via GitGitGadget , Git Mailing List Subject: Re: [PATCH v2] git: update documentation for --git-dir Message-ID: <20200128073340.GA564804@coredump.intra.peff.net> References: MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org On Tue, Jan 28, 2020 at 05:17:49PM +1300, Heba Waly wrote: > On Mon, Jan 27, 2020 at 7:29 PM Johannes Sixt wrote: > > > > Does this render well? Judging by the precedent set by the descriptions > > of -C and -c options earlier in this file, continuation paragraphs > > should not be indented and separated by a line with just a plus sign > > instead of an empty line. > > It doesn't render well, thanks for pointing it out, will send an > updated version. One tool that might help as you do documentation patches: there's a doc-diff script that shows the rendered differences. Try: cd Documentation ./doc-diff HEAD^ HEAD (on a branch with your patch at the tip). It was originally written to investigate changes to the markup, etc, but I find it's useful just for looking at any documentation patch, because it takes you right to the part that changed. :) -Peff