From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id D51A5C433EF for ; Fri, 3 Sep 2021 15:11:28 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id BAE46610D2 for ; Fri, 3 Sep 2021 15:11:28 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S236353AbhICPM2 (ORCPT ); Fri, 3 Sep 2021 11:12:28 -0400 Received: from ms.lwn.net ([45.79.88.28]:46748 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229789AbhICPM1 (ORCPT ); Fri, 3 Sep 2021 11:12:27 -0400 X-Greylist: delayed 61319 seconds by postgrey-1.27 at vger.kernel.org; Fri, 03 Sep 2021 11:12:27 EDT Received: from localhost (unknown [IPv6:2601:281:8300:104d::5f6]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 4D2C5663B; Fri, 3 Sep 2021 15:11:27 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 4D2C5663B DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1630681887; bh=I7eHpaDCMcn+gV/Go7uz+qvINtjF5jC2bNVhtMJtDN0=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=p6w3uIRTp7YZD/LBsZ1EruHgD6tJFHamUaUv8UelNcPQz32KefofopmreGzFM5xf5 ZLJZgbQjMEoOgBt1iUux4MbXjEsOU/MjE+7bFZO28z5QIWVUtq96t4OHkjvum0SYGs ffXXBq6uVgnuk7PdlkWjbAcbxbhlRA6RpMjTAHf1Kek8Ck9FJFI0JaZz4UlVkzrKqj lrXSthYiEN6oi+z0on3n7gTwt8I0ssWaVNec6+vvght4/8+rHTyWmBZ8S6gJ3iivBN EDqOr01NNs0DMRGnifT7kQPWGPN9zxwvNt7VS1qJjVEQItvEQoCZTmTvMF/zn+zXAU 0yJbSUDV5oNvQ== From: Jonathan Corbet To: Akira Yokosawa Cc: jack@suse.cz, linux-doc@vger.kernel.org, linux-ext4@vger.kernel.org, tytso@mit.edu, Akira Yokosawa , Mauro Carvalho Chehab Subject: Re: [PATCH 1/2] ext4: docs: switch away from list-table In-Reply-To: References: <20210902220854.198850-2-corbet@lwn.net> Date: Fri, 03 Sep 2021 09:11:26 -0600 Message-ID: <871r65zobl.fsf@meer.lwn.net> MIME-Version: 1.0 Content-Type: text/plain Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org Akira Yokosawa writes: [Adding Mauro] > On Thu, 2 Sep 2021 16:08:53 -0600, Jonathan Corbet wrote: > >> Commit 3a6541e97c03 (Add documentation about the orphan file feature) added >> a new document on orphan files, which is great. But the use of >> "list-table" results in documents that are absolutely unreadable in their >> plain-text form. Switch this file to the regular RST table format instead; >> the rendered (HTML) output is identical. > > In the "list tables" section of doc-guide/sphinx.rst, the first paragraph > starts with the sentence: > > We recommend the use of list table formats. > > Yes, the disadvantage of list tables is mentioned later in the paragraph: > > Compared to the ASCII-art they might not be as comfortable for readers > of the text files. > > , but I still see list-table is meant as the preferred format. Interesting...that is not at all my memory of the discussions we had at that time. There was a lot of pushback against anything that makes the RST files less readable - still is, if certain people join the conversation. Tables were one of the early flash points. Mauro, you added that text; do you remember things differently? Do you feel we should retain that recommendation? Thanks, jon