Received-SPF: pass (google.com: domain of linux-kernel+bounces-123761-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Message-ID: <cde3dc6e-ca77-445e-a4b7-fc21a934999a@infradead.org>
Date: Thu, 28 Mar 2024 15:11:03 -0700
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH v16 01/20] security: add ipe lsm
Content-Language: en-US
To: Jarkko Sakkinen <jarkko@kernel.org>, Fan Wu <wufan@linux.microsoft.com>,
 corbet@lwn.net, zohar@linux.ibm.com, jmorris@namei.org, serge@hallyn.com,
 tytso@mit.edu, ebiggers@kernel.org, axboe@kernel.dk, agk@redhat.com,
 snitzer@kernel.org, eparis@redhat.com, paul@paul-moore.com
Cc: linux-doc@vger.kernel.org, linux-integrity@vger.kernel.org,
 linux-security-module@vger.kernel.org, fsverity@lists.linux.dev,
 linux-block@vger.kernel.org, dm-devel@lists.linux.dev,
 audit@vger.kernel.org, linux-kernel@vger.kernel.org,
 Deven Bowers <deven.desai@linux.microsoft.com>
References: <1711657047-10526-1-git-send-email-wufan@linux.microsoft.com>
 <1711657047-10526-2-git-send-email-wufan@linux.microsoft.com>
 <D05ODONHFJ9O.3VG0HLFPA1OB0@kernel.org>
From: Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <D05ODONHFJ9O.3VG0HLFPA1OB0@kernel.org>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit


On 3/28/24 13:45, Jarkko Sakkinen wrote:
>> +/**
>> + * ipe_init - Entry point of IPE.
>> + *
>> + * This is called at LSM init, which happens occurs early during kernel
>> + * start up. During this phase, IPE registers its hooks and loads the
>> + * builtin boot policy.
>> + * Return:
>> + * * 0		- OK
>> + * * -ENOMEM	- Out of memory
> Just a suggestion:
> 
> * 0:		OK
> * -ENOMEM:	Out of memory (OOM)
> 
> Rationale being more readable (less convoluted).
> 
> And also sort of symmetrical how parameters are formatted in kdoc.

It needs the " * *" to make a formatted list in the generated output.
Otherwise the use of '- or ':' as a separator doesn't matter AFAIK.

-- 
#Randy