All of lore.kernel.org
 help / color / mirror / Atom feed
From: Nick Terrell <terrelln@fb.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: "Nick Terrell" <nickrterrell@gmail.com>,
	"Herbert Xu" <herbert@gondor.apana.org.au>,
	"linux-crypto@vger.kernel.org" <linux-crypto@vger.kernel.org>,
	"Btrfs BTRFS" <linux-btrfs@vger.kernel.org>,
	"squashfs-devel@lists.sourceforge.net"
	<squashfs-devel@lists.sourceforge.net>,
	"linux-f2fs-devel@lists.sourceforge.net"
	<linux-f2fs-devel@lists.sourceforge.net>,
	LKML <linux-kernel@vger.kernel.org>,
	"Kernel Team" <Kernel-team@fb.com>, "Chris Mason" <clm@fb.com>,
	"Petr Malat" <oss@malat.biz>, "Johannes Weiner" <jweiner@fb.com>,
	"Niket Agarwal" <niketa@fb.com>, "Yann Collet" <cyan@fb.com>,
	"Christoph Hellwig" <hch@infradead.org>,
	"Michał Mirosław" <mirq-linux@rere.qmqm.pl>,
	"David Sterba" <dsterba@suse.cz>,
	"Oleksandr Natalenko" <oleksandr@natalenko.name>,
	"Felix Handte" <felixh@fb.com>,
	"Eric Biggers" <ebiggers@kernel.org>
Subject: Re: [GIT PULL][PATCH v10 0/4] Update to zstd-1.4.10
Date: Tue, 27 Apr 2021 23:39:50 +0000	[thread overview]
Message-ID: <E3BBA2E7-F6ED-44E3-8FBA-7EF4D67FEBDB@fb.com> (raw)
In-Reply-To: <10397ef2-119d-b065-2e82-cac1d800dfd0@infradead.org>



> On Apr 27, 2021, at 3:09 PM, Randy Dunlap <rdunlap@infradead.org> wrote:
> 
> On 4/26/21 4:46 PM, Nick Terrell wrote:
>> From: Nick Terrell <terrelln@fb.com>
>> 
>> Please pull from
>> 
>>  git@github.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
> 


WARNING: multiple messages have this Message-ID (diff)
From: Nick Terrell via Linux-f2fs-devel <linux-f2fs-devel@lists.sourceforge.net>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: "squashfs-devel@lists.sourceforge.net"
	<squashfs-devel@lists.sourceforge.net>,
	"Eric Biggers" <ebiggers@kernel.org>,
	"Herbert Xu" <herbert@gondor.apana.org.au>,
	"Christoph Hellwig" <hch@infradead.org>,
	"Nick Terrell" <nickrterrell@gmail.com>,
	"Yann Collet" <cyan@fb.com>, "David Sterba" <dsterba@suse.cz>,
	LKML <linux-kernel@vger.kernel.org>,
	"linux-f2fs-devel@lists.sourceforge.net"
	<linux-f2fs-devel@lists.sourceforge.net>,
	"Petr Malat" <oss@malat.biz>, "Chris Mason" <clm@fb.com>,
	"linux-crypto@vger.kernel.org" <linux-crypto@vger.kernel.org>,
	"Felix Handte" <felixh@fb.com>,
	"Oleksandr Natalenko" <oleksandr@natalenko.name>,
	"Kernel Team" <Kernel-team@fb.com>,
	"Michał Mirosław" <mirq-linux@rere.qmqm.pl>,
	"Niket Agarwal" <niketa@fb.com>,
	"Btrfs BTRFS" <linux-btrfs@vger.kernel.org>,
	"Johannes Weiner" <jweiner@fb.com>
Subject: Re: [f2fs-dev] [GIT PULL][PATCH v10 0/4] Update to zstd-1.4.10
Date: Tue, 27 Apr 2021 23:39:50 +0000	[thread overview]
Message-ID: <E3BBA2E7-F6ED-44E3-8FBA-7EF4D67FEBDB@fb.com> (raw)
In-Reply-To: <10397ef2-119d-b065-2e82-cac1d800dfd0@infradead.org>



> On Apr 27, 2021, at 3:09 PM, Randy Dunlap <rdunlap@infradead.org> wrote:
> 
> On 4/26/21 4:46 PM, Nick Terrell wrote:
>> From: Nick Terrell <terrelln@fb.com>
>> 
>> Please pull from
>> 
>>  git@github.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
> 


_______________________________________________
Linux-f2fs-devel mailing list
Linux-f2fs-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel

  reply	other threads:[~2021-04-27 23:40 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-26 23:46 [GIT PULL][PATCH v10 0/4] Update to zstd-1.4.10 Nick Terrell
2021-04-26 23:46 ` [f2fs-dev] " Nick Terrell
2021-04-26 23:46 ` [PATCH v10 1/4] lib: zstd: Add kernel-specific API Nick Terrell
2021-04-26 23:46   ` [f2fs-dev] " Nick Terrell
2021-04-26 23:46 ` [PATCH v10 2/4] lib: zstd: Add decompress_sources.h for decompress_unzstd Nick Terrell
2021-04-26 23:46   ` [f2fs-dev] " Nick Terrell
2021-04-26 23:46 ` [PATCH v10 3/4] lib: zstd: Upgrade to latest upstream zstd version 1.4.10 Nick Terrell
2021-04-26 23:46   ` [f2fs-dev] " Nick Terrell
2021-04-27  3:57   ` kernel test robot
2021-04-27  3:57     ` kernel test robot
2021-04-26 23:46 ` [PATCH v10 4/4] MAINTAINERS: Add maintainer entry for zstd Nick Terrell
2021-04-26 23:46   ` [f2fs-dev] " Nick Terrell
2021-04-27  6:26 ` [GIT PULL][PATCH v10 0/4] Update to zstd-1.4.10 Oleksandr Natalenko
2021-04-27  6:26   ` [f2fs-dev] " Oleksandr Natalenko via Linux-f2fs-devel
2021-04-27 22:09 ` Randy Dunlap
2021-04-27 22:09   ` [f2fs-dev] " Randy Dunlap
2021-04-27 23:39   ` Nick Terrell [this message]
2021-04-27 23:39     ` Nick Terrell via Linux-f2fs-devel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=E3BBA2E7-F6ED-44E3-8FBA-7EF4D67FEBDB@fb.com \
    --to=terrelln@fb.com \
    --cc=Kernel-team@fb.com \
    --cc=clm@fb.com \
    --cc=cyan@fb.com \
    --cc=dsterba@suse.cz \
    --cc=ebiggers@kernel.org \
    --cc=felixh@fb.com \
    --cc=hch@infradead.org \
    --cc=herbert@gondor.apana.org.au \
    --cc=jweiner@fb.com \
    --cc=linux-btrfs@vger.kernel.org \
    --cc=linux-crypto@vger.kernel.org \
    --cc=linux-f2fs-devel@lists.sourceforge.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mirq-linux@rere.qmqm.pl \
    --cc=nickrterrell@gmail.com \
    --cc=niketa@fb.com \
    --cc=oleksandr@natalenko.name \
    --cc=oss@malat.biz \
    --cc=rdunlap@infradead.org \
    --cc=squashfs-devel@lists.sourceforge.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.