Re: [PATCH v3 2/3] Documentation: riscv: Add early boot document

[Jonathan Corbet]

Alexandre Ghiti <alexghiti@xxxxxxxxxxxx> 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 :)

Thanks,

jon