linux-kernel - Re: [f2fs-dev] [PATCH 1/2] fs: docs: f2fs.rst: fix a broken table

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <1f9b6b21-4593-8b72-1726-b65a5fd77e10@huawei.com>
Date:   Mon, 8 Jun 2020 09:41:44 +0800
From:   Chao Yu <yuchao0@...wei.com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>
CC:     Jonathan Corbet <corbet@....net>, <linux-kernel@...r.kernel.org>,
        <linux-f2fs-devel@...ts.sourceforge.net>,
        Jaegeuk Kim <jaegeuk@...nel.org>
Subject: Re: [f2fs-dev] [PATCH 1/2] fs: docs: f2fs.rst: fix a broken table

On 2020/6/3 6:38, Mauro Carvalho Chehab wrote:
> As reported by Sphinx:
> 
> 	Documentation/filesystems/f2fs.rst:229: WARNING: Malformed table.
> 	Text in column margin in table line 126.
> 
> 	====================== ============================================================
> 	background_gc=%s       Turn on/off cleaning operations, namely garbage
> ...
> 	test_dummy_encryption
> 	test_dummy_encryption=%s
> 	                       Enable dummy encryption, which provides a fake fscrypt
> 	                       context. The fake fscrypt context is used by xfstests.
> 	                       The argument may be either "v1" or "v2", in order to
> 	                       select the corresponding fscrypt policy version.
> 
> This table is now broken, as some texts are bigger than a
> column. While it would be feasible to fix it by adding two extra
> positions at the table, it would still output something wrong,
> as "test_dummy_encryption" would appear on a separate row.
> 
> So, the best solution here seems to remove the table markup.
> 
> The html and PDF output won't be as nice as a table, but it will
> still be reasonable.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

Reviewed-by: Chao Yu <yuchao0@...wei.com>

Thanks,