diff mbox series

[01/13] Documentation/cxl: Add bus internal docs

Message ID 20210902195017.2516472-2-ben.widawsky@intel.com
State New, archived
Headers show
Series Enumerate midlevel and endpoint decoders | expand

Commit Message

Ben Widawsky Sept. 2, 2021, 7:50 p.m. UTC
Kernel docs are already present in this file, but nothing is instructed
to generate them. Address that.

Signed-off-by: Ben Widawsky <ben.widawsky@intel.com>
---
 Documentation/driver-api/cxl/memory-devices.rst | 3 +++
 1 file changed, 3 insertions(+)

Comments

Jonathan Cameron Sept. 3, 2021, 2:05 p.m. UTC | #1
On Thu, 2 Sep 2021 12:50:05 -0700
Ben Widawsky <ben.widawsky@intel.com> wrote:

> Kernel docs are already present in this file, but nothing is instructed
> to generate them. Address that.
> 
> Signed-off-by: Ben Widawsky <ben.widawsky@intel.com>

FWIW
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Arguably nothing to do with the later bits of the set though so
I'd have had these doc improvements in a mini set of their own.



> ---
>  Documentation/driver-api/cxl/memory-devices.rst | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/Documentation/driver-api/cxl/memory-devices.rst b/Documentation/driver-api/cxl/memory-devices.rst
> index 356f70d28316..a18175bae7a6 100644
> --- a/Documentation/driver-api/cxl/memory-devices.rst
> +++ b/Documentation/driver-api/cxl/memory-devices.rst
> @@ -39,6 +39,9 @@ CXL Core
>  .. kernel-doc:: drivers/cxl/core/bus.c
>     :doc: cxl core
>  
> +.. kernel-doc:: drivers/cxl/core/bus.c
> +   :identifiers:
> +
>  .. kernel-doc:: drivers/cxl/core/pmem.c
>     :internal:
>
Dan Williams Sept. 10, 2021, 6:20 p.m. UTC | #2
On Fri, Sep 3, 2021 at 7:06 AM Jonathan Cameron
<Jonathan.Cameron@huawei.com> wrote:
>
> On Thu, 2 Sep 2021 12:50:05 -0700
> Ben Widawsky <ben.widawsky@intel.com> wrote:
>
> > Kernel docs are already present in this file, but nothing is instructed
> > to generate them. Address that.
> >
> > Signed-off-by: Ben Widawsky <ben.widawsky@intel.com>
>
> FWIW
> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>
> Arguably nothing to do with the later bits of the set though so
> I'd have had these doc improvements in a mini set of their own.

As long as whoever merges this knows that it could go into its own
topic branch if need be I think it's easier for contributors to send
straight line sets. My only ask is that the set is organized as fixes
=> cleanups => features. If a mildly "unrelated" change sneaks in not
related with the "feature" patches, that's ok to me.
diff mbox series

Patch

diff --git a/Documentation/driver-api/cxl/memory-devices.rst b/Documentation/driver-api/cxl/memory-devices.rst
index 356f70d28316..a18175bae7a6 100644
--- a/Documentation/driver-api/cxl/memory-devices.rst
+++ b/Documentation/driver-api/cxl/memory-devices.rst
@@ -39,6 +39,9 @@  CXL Core
 .. kernel-doc:: drivers/cxl/core/bus.c
    :doc: cxl core
 
+.. kernel-doc:: drivers/cxl/core/bus.c
+   :identifiers:
+
 .. kernel-doc:: drivers/cxl/core/pmem.c
    :internal: