Date:   Thu, 2 Feb 2023 16:07:32 -0300
From:   Marcos Paulo de Souza <mpdesouza@suse.de>
To:     Luis Chamberlain <mcgrof@kernel.org>
Cc:     Marcos Paulo de Souza <mpdesouza@suse.com>,
        linux-modules@vger.kernel.org, linux-kernel@vger.kernel.org,
        live-patching@vger.kernel.org
Subject: Re: [PATCH] module.h: Document klp_modinfo struct members
Message-ID: <20230202190732.tyqn2wwrvy3ot56f@daedalus>
References: <20230202182950.10471-1-mpdesouza@suse.com>
 <Y9wIw3f8IBOs4Ad6@bombadil.infradead.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <Y9wIw3f8IBOs4Ad6@bombadil.infradead.org>
Precedence: bulk

On Thu, Feb 02, 2023 at 11:02:27AM -0800, Luis Chamberlain wrote:
> On Thu, Feb 02, 2023 at 03:29:50PM -0300, Marcos Paulo de Souza wrote:
> > The struct members description can be found on
> > Documentation/livepatch/module-elf-format.rst, but for a developer it's
> > easier to search for such information looking at the struct definition.
> > 
> > Signed-off-by: Marcos Paulo de Souza <mpdesouza@suse.com>
> 
> Why not just embrace kdoc and then refer to it in the rst files?

Seems to be a very good idea Luis. I'll try to find some examples in our Docs
how this is done.

Thanks

> 
>   Luis