diff mbox series

[3/3] cxl/docs: Remove undocumented references

Message ID 20210830171726.2342558-3-ben.widawsky@intel.com
State Superseded
Headers show
Series [1/3] cxl: Fixed defined but not used warnings | expand

Commit Message

Ben Widawsky Aug. 30, 2021, 5:17 p.m. UTC
When the core pmem and regs implementation was added, there were no
structured comments added. This change allows docs to be generated
without warnings.

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

Comments

Dan Williams Sept. 1, 2021, 7:18 p.m. UTC | #1
On Mon, Aug 30, 2021 at 10:17 AM Ben Widawsky <ben.widawsky@intel.com> wrote:
>
> When the core pmem and regs implementation was added, there were no
> structured comments added. This change allows docs to be generated
> without warnings.
>

Hmm, might be better to go the other and fix this with patches to add
documentation. At least devm_cxl_add_nvdimm_bridge() would benefit and
regs.c has some kernel-doc annotations, just needs the header section
added.
Ben Widawsky Sept. 2, 2021, 5:09 p.m. UTC | #2
On 21-09-01 12:18:59, Dan Williams wrote:
> On Mon, Aug 30, 2021 at 10:17 AM Ben Widawsky <ben.widawsky@intel.com> wrote:
> >
> > When the core pmem and regs implementation was added, there were no
> > structured comments added. This change allows docs to be generated
> > without warnings.
> >
> 
> Hmm, might be better to go the other and fix this with patches to add
> documentation. At least devm_cxl_add_nvdimm_bridge() would benefit and
> regs.c has some kernel-doc annotations, just needs the header section
> added.

That'd be my preference, but I'll leave that to you if that's okay.
diff mbox series

Patch

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