lkml.org 
[lkml]   [2023]   [Jun]   [26]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Date
SubjectRe: [PATCH v3 2/3] Documentation: riscv: Add early boot document
On Sun, Jun 25, 2023 at 10:39 PM Jonathan Corbet <corbet@lwn.net> wrote:
>
> Alexandre Ghiti <alexghiti@rivosinc.com> writes:
>
> >> Please don't use :c:func:. If you just write setup_vm(), all the right
> >> magic will happen.
> >
> > The magic indeed happens with virt_to_phys()/phys_to_virt(), but not
> > with setup_vm(): is there something we should do when declaring those
> > functions?
>
> If the function in question has no kerneldoc comment, there will be
> nothing to make the magic link to. In other words, if you want it to
> link to the documentation, the documentation needs to actually exist :)

Ok, that's for another patchset then, thanks for your help!

>
> Thanks,
>
> jon

\
 
 \ /
  Last update: 2023-06-26 16:33    [W:0.040 / U:0.104 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site