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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <877crrl1jm.fsf@meer.lwn.net>
Date:   Sun, 25 Jun 2023 14:39:09 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Alexandre Ghiti <alexghiti@...osinc.com>
Cc:     Paul Walmsley <paul.walmsley@...ive.com>,
        Palmer Dabbelt <palmer@...belt.com>,
        Albert Ou <aou@...s.berkeley.edu>,
        Björn Töpel 
        <bjorn@...osinc.com>, Andrew Jones <ajones@...tanamicro.com>,
        Conor Dooley <conor.dooley@...rochip.com>,
        Sunil V L <sunilvl@...tanamicro.com>,
        Song Shuai <songshuaishuai@...ylab.org>,
        linux-doc@...r.kernel.org, linux-riscv@...ts.infradead.org,
        linux-kernel@...r.kernel.org, Palmer Dabbelt <palmer@...osinc.com>
Subject: Re: [PATCH v3 2/3] Documentation: riscv: Add early boot document

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

Thanks,

jon