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: AS3215 2.6.0.0/16 X-Spam-Status: No, score=-3.2 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from out1.vger.email (out1.vger.email [IPv6:2620:137:e000::1:20]) by dcvr.yhbt.net (Postfix) with ESMTP id D6CDE1F66E for ; Wed, 8 Jun 2022 03:06:04 +0000 (UTC) Authentication-Results: dcvr.yhbt.net; dkim=pass (2048-bit key; unprotected) header.d=ttaylorr-com.20210112.gappssmtp.com header.i=@ttaylorr-com.20210112.gappssmtp.com header.b="iUDm/KjC"; dkim-atps=neutral Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1344462AbiFHDDJ (ORCPT ); Tue, 7 Jun 2022 23:03:09 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35202 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1358460AbiFHDCG (ORCPT ); Tue, 7 Jun 2022 23:02:06 -0400 Received: from mail-qv1-xf32.google.com (mail-qv1-xf32.google.com [IPv6:2607:f8b0:4864:20::f32]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0C7262019F for ; Tue, 7 Jun 2022 13:51:39 -0700 (PDT) Received: by mail-qv1-xf32.google.com with SMTP id cv1so13157647qvb.5 for ; Tue, 07 Jun 2022 13:51:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ttaylorr-com.20210112.gappssmtp.com; s=20210112; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to; bh=Bghxs1SgDQu9Zw06c+FDI/seRn4wv6omJDTzAcBEb5g=; b=iUDm/KjCLJZ8l67Oj2gX9GQxgXE7MxX1XT/ZiygHkRmRLACWHai7CYza0jC5RFrOKj o8K30JoXcHOsbAQeOsqy6rBf3R92gxjFNWAuugyqBIa9W6+aZijw/X3rYL7divda3nnS MSF/9tyQC2h3pKvhZ+Qn0KcAFHtt/xXhfAvKOcFZ0jVieKL3FHCzZ3YIRvUOkikC3+Cf VsTwM2Ous1S/N+QkgQ7Pf2mDkv/9RaHo9OmxTe9lIYkfrtdQVqOgWbNDXT7jFnDVriis U2qv4LvhItC4Kl6wKVw9ZFRMZq/vl0VdAejVwftG8LXXAAQI5g1Jhcs5ASjKzH96i5hZ vtzw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=Bghxs1SgDQu9Zw06c+FDI/seRn4wv6omJDTzAcBEb5g=; b=oYkruoUkotyPjPKmxN3ApTKl3uHxpwyCGd+JLuitaTBjqWNmNM57nsgaFMfhbM9OuB u5AcQYLPso2XkaLvL3OaRf2QmLhuXsmqs7+Gxmee60OaPTJ1LX9nckg9q9WXOusXEm5P iIhmsEUdUO2SAH9EH/BaVqeWbNfztWE5h0O0XajByDCDh66ULflG9BfAXyEe5fpRxTIe VhSfq1Gsglvj/FOi/T6P6B5fVAysOq890i6Q2GavLFOn9xrDXrBgS7I0jIZc36I3u2Zu 0JrH0WsspIZ/CeDsTbr0x1+0JOUeCSz1IVe14R24GEBy6bBdQPXIYBZCrsGYgAcXAeKO zoIQ== X-Gm-Message-State: AOAM533cB+kBVxp3msMGaJ7FATxWwn5T0mm6Yv7Hylx+rc3pXUcq9On8 R1/leHRwc80uWuPuUbfK1xgNtDOCQueVEph3 X-Google-Smtp-Source: ABdhPJyTrzzw4TZW2Hg7pVeuq4se4f+UDkryf0u9pxtVIhpDNWPG4pj4Qh2e/m2lgbT0E+QBxGe1lg== X-Received: by 2002:ad4:5fcf:0:b0:467:dc87:82ff with SMTP id jq15-20020ad45fcf000000b00467dc8782ffmr19208240qvb.14.1654635098149; Tue, 07 Jun 2022 13:51:38 -0700 (PDT) Received: from localhost (104-178-186-189.lightspeed.milwwi.sbcglobal.net. [104.178.186.189]) by smtp.gmail.com with ESMTPSA id c8-20020ac86e88000000b00304f55e56e4sm2548042qtv.40.2022.06.07.13.51.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Jun 2022 13:51:37 -0700 (PDT) Date: Tue, 7 Jun 2022 16:51:37 -0400 From: Taylor Blau To: Abhradeep Chakraborty via GitGitGadget Cc: git@vger.kernel.org, Vicent Marti , Kaartic Sivaraam , Derrick Stolee , Junio C Hamano , Abhradeep Chakraborty Subject: Re: [PATCH v2 2/3] bitmap-format.txt: fix some formatting issues Message-ID: References: MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org On Tue, Jun 07, 2022 at 05:43:33PM +0000, Abhradeep Chakraborty via GitGitGadget wrote: > From: Abhradeep Chakraborty > > The asciidoc generated html for `Documentation/technical/bitmap- > format.txt` is broken. This is mainly because `-` is used for nested > lists (which is not allowed in asciidoc) instead of `*`. > > Fix these and also reformat it (e.g. removing some blank lines) for > better readability of the html page. Hmm. When I render the HTML for this page and view it in my browser, the removed blank lines makes the contents of the section "2-byte flags (network byte order)" run together, and I think it hurts readability IMHO. Is there a way to keep those line breaks without significantly reformatting the source of this file? > Signed-off-by: Abhradeep Chakraborty > --- > Documentation/technical/bitmap-format.txt | 20 +++++++------------- > 1 file changed, 7 insertions(+), 13 deletions(-) > > diff --git a/Documentation/technical/bitmap-format.txt b/Documentation/technical/bitmap-format.txt > index 04b3ec21785..f22669b5916 100644 > --- a/Documentation/technical/bitmap-format.txt > +++ b/Documentation/technical/bitmap-format.txt > @@ -39,7 +39,7 @@ MIDXs, both the bit-cache and rev-cache extensions are required. > > == On-disk format > > - - A header appears at the beginning: > + * A header appears at the beginning: > > 4-byte signature: {'B', 'I', 'T', 'M'} Similarly, everything below the "A header appears at the beginning" list item appears in a 
 element, so the rendered HTML looks more
like plaintext to me.

This isn't new from your patch, but I wonder if now is a good
opportunity to make some light use of the formatting options that
ASCIIDoc gives us to make the page read a little bit more easily when
rendered as HTML.

I don't want to compromise too much on the readability of the .txt file,
though, so if there isn't a good way to strike this balance, then I
trust you and think we should leave it as you have modified things here.

Thanks,
Taylor