diff mbox series

[1/1] lmb: add missing LMB_NOOVERWRITE description

Message ID 20240918213934.19875-1-heinrich.schuchardt@canonical.com
State Superseded, archived
Delegated to: Heinrich Schuchardt
Headers show
Series [1/1] lmb: add missing LMB_NOOVERWRITE description | expand

Commit Message

Heinrich Schuchardt Sept. 18, 2024, 9:39 p.m. UTC
Without a LMB_NOOVERWRITE building the HTML documentation leads to a
warning which should be treated as an error.

Fixes: 5e9553cc72b8 ("lmb: allow for resizing lmb regions")
Reported-by: Tom Rini <trini@konsulko.com>
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 include/lmb.h | 1 +
 1 file changed, 1 insertion(+)

Comments

Ilias Apalodimas Sept. 19, 2024, 7:05 a.m. UTC | #1
On Thu, 19 Sept 2024 at 00:39, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> Without a LMB_NOOVERWRITE building the HTML documentation leads to a
> warning which should be treated as an error.
>
> Fixes: 5e9553cc72b8 ("lmb: allow for resizing lmb regions")
> Reported-by: Tom Rini <trini@konsulko.com>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  include/lmb.h | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/include/lmb.h b/include/lmb.h
> index fc2daaa7bfc..8ed5ac0a4fc 100644
> --- a/include/lmb.h
> +++ b/include/lmb.h
> @@ -18,6 +18,7 @@
>   * enum lmb_flags - definition of memory region attributes
>   * @LMB_NONE: no special request
>   * @LMB_NOMAP: don't add to mmu configuration
> + * @LMB_NOOVERWRITE: region cannot be resized

I think the description is 'can't be overwritten. Sughosh?

Also, I'd drop the Fixes tag for non code issues.

Thanks
/Ilias
>   */
>  enum lmb_flags {
>         LMB_NONE                = 0,
> --
> 2.45.2
>
Sughosh Ganu Sept. 19, 2024, 7:26 a.m. UTC | #2
On Thu, 19 Sept 2024 at 12:35, Ilias Apalodimas
<ilias.apalodimas@linaro.org> wrote:
>
> On Thu, 19 Sept 2024 at 00:39, Heinrich Schuchardt
> <heinrich.schuchardt@canonical.com> wrote:
> >
> > Without a LMB_NOOVERWRITE building the HTML documentation leads to a
> > warning which should be treated as an error.
> >
> > Fixes: 5e9553cc72b8 ("lmb: allow for resizing lmb regions")
> > Reported-by: Tom Rini <trini@konsulko.com>
> > Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> > ---
> >  include/lmb.h | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/include/lmb.h b/include/lmb.h
> > index fc2daaa7bfc..8ed5ac0a4fc 100644
> > --- a/include/lmb.h
> > +++ b/include/lmb.h
> > @@ -18,6 +18,7 @@
> >   * enum lmb_flags - definition of memory region attributes
> >   * @LMB_NONE: no special request
> >   * @LMB_NOMAP: don't add to mmu configuration
> > + * @LMB_NOOVERWRITE: region cannot be resized
>
> I think the description is 'can't be overwritten. Sughosh?

True, 'can't be overwritten' might be a more accurate description.
Maybe, 'cannot be overwritten or resized' should also be fine.

-sughosh

>
> Also, I'd drop the Fixes tag for non code issues.
>
> Thanks
> /Ilias
> >   */
> >  enum lmb_flags {
> >         LMB_NONE                = 0,
> > --
> > 2.45.2
> >
diff mbox series

Patch

diff --git a/include/lmb.h b/include/lmb.h
index fc2daaa7bfc..8ed5ac0a4fc 100644
--- a/include/lmb.h
+++ b/include/lmb.h
@@ -18,6 +18,7 @@ 
  * enum lmb_flags - definition of memory region attributes
  * @LMB_NONE: no special request
  * @LMB_NOMAP: don't add to mmu configuration
+ * @LMB_NOOVERWRITE: region cannot be resized
  */
 enum lmb_flags {
 	LMB_NONE		= 0,