linux-kernel - Re: [GIT PULL][PATCH v10 0/4] Update to zstd-1.4.10

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] [day] [month] [year] [list]

Message-ID: <E3BBA2E7-F6ED-44E3-8FBA-7EF4D67FEBDB@fb.com>
Date:   Tue, 27 Apr 2021 23:39:50 +0000
From:   Nick Terrell <terrelln@...com>
To:     Randy Dunlap <rdunlap@...radead.org>
CC:     Nick Terrell <nickrterrell@...il.com>,
        Herbert Xu <herbert@...dor.apana.org.au>,
        "linux-crypto@...r.kernel.org" <linux-crypto@...r.kernel.org>,
        Btrfs BTRFS <linux-btrfs@...r.kernel.org>,
        "squashfs-devel@...ts.sourceforge.net" 
        <squashfs-devel@...ts.sourceforge.net>,
        "linux-f2fs-devel@...ts.sourceforge.net" 
        <linux-f2fs-devel@...ts.sourceforge.net>,
        LKML <linux-kernel@...r.kernel.org>,
        Kernel Team <Kernel-team@...com>, Chris Mason <clm@...com>,
        Petr Malat <oss@...at.biz>, Johannes Weiner <jweiner@...com>,
        Niket Agarwal <niketa@...com>, Yann Collet <cyan@...com>,
        Christoph Hellwig <hch@...radead.org>,
        Michał Mirosław <mirq-linux@...e.qmqm.pl>,
        David Sterba <dsterba@...e.cz>,
        "Oleksandr Natalenko" <oleksandr@...alenko.name>,
        Felix Handte <felixh@...com>,
        "Eric Biggers" <ebiggers@...nel.org>
Subject: Re: [GIT PULL][PATCH v10 0/4] Update to zstd-1.4.10



> On Apr 27, 2021, at 3:09 PM, Randy Dunlap <rdunlap@...radead.org> wrote:
> 
> On 4/26/21 4:46 PM, Nick Terrell wrote:
>> From: Nick Terrell <terrelln@...com>
>> 
>> Please pull from
>> 
>>  git@...hub.com:terrelln/linux.git tags/v10-zstd-1.4.10
>> 
>> to get these changes. Alternatively the patchset is included.
>> 
>> This patchset lists me as the maintainer for zstd and upgrades the zstd library
>> to the latest upstream release. The current zstd version in the kernel is a
>> modified version of upstream zstd-1.3.1. At the time it was integrated, zstd
>> wasn't ready to be used in the kernel as-is. But, it is now possible to use
>> upstream zstd directly in the kernel.
> 
> Hi Nick,
> 
> Several of the source (.c, .h) files use comments blocks that
> begin with "/**", which means "this is the beginning of a kernel-doc
> comment" when in the kernel source tree. However, they are not in
> kernel-doc format.
> 
> During the automatic generation from upstream zstd, please find a way
> to change /** to /*.
> 
> This does need to slow down the acceptance of this patch series IMO.

Sure, I can do that easily enough. The public header `include/linux/zstd.h`
already does have correct kernel-doc comments. It is just the non-public files
that don’t follow the kernel-doc style, since zstd has its own documentation
format which is similar to doxygen style.

Best,
Nick

> thanks.
> -- 
> ~Randy
>