From: Jonathan Corbet <corbet@lwn.net>
To: Alexandre Ghiti <alexghiti@rivosinc.com>
Cc: "Paul Walmsley" <paul.walmsley@sifive.com>,
"Palmer Dabbelt" <palmer@dabbelt.com>,
"Albert Ou" <aou@eecs.berkeley.edu>,
"Björn Töpel" <bjorn@rivosinc.com>,
"Andrew Jones" <ajones@ventanamicro.com>,
"Conor Dooley" <conor.dooley@microchip.com>,
"Sunil V L" <sunilvl@ventanamicro.com>,
"Song Shuai" <songshuaishuai@tinylab.org>,
linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org,
linux-kernel@vger.kernel.org,
"Palmer Dabbelt" <palmer@rivosinc.com>
Subject: Re: [PATCH v3 2/3] Documentation: riscv: Add early boot document
Date: Sun, 25 Jun 2023 14:39:09 -0600 [thread overview]
Message-ID: <877crrl1jm.fsf@meer.lwn.net> (raw)
In-Reply-To: <CAHVXubhk2xf59XbNiRYKdr4J1yadpeX0KMgW1cFMR4GRN97MYA@mail.gmail.com>
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 :)
Thanks,
jon
next prev parent reply other threads:[~2023-06-25 20:39 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-23 9:55 [PATCH v3 1/3] Documentation: arm: Add bootargs to the table of added DT parameters Alexandre Ghiti
2023-06-23 9:55 ` [PATCH v3 2/3] Documentation: riscv: Add early boot document Alexandre Ghiti
2023-06-23 13:44 ` Jonathan Corbet
2023-06-25 8:31 ` Alexandre Ghiti
2023-06-25 20:39 ` Jonathan Corbet [this message]
2023-06-26 14:32 ` Alexandre Ghiti
2023-06-23 19:12 ` Atish Patra
2023-06-24 0:26 ` kernel test robot
2023-06-25 2:33 ` Song Shuai
2023-06-23 9:55 ` [PATCH v3 3/3] Documentation: riscv: Update boot image header since EFI stub is supported Alexandre Ghiti
2023-06-23 19:01 ` [PATCH v3 1/3] Documentation: arm: Add bootargs to the table of added DT parameters Atish Patra
2023-06-25 2:34 ` Song Shuai
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=877crrl1jm.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=ajones@ventanamicro.com \
--cc=alexghiti@rivosinc.com \
--cc=aou@eecs.berkeley.edu \
--cc=bjorn@rivosinc.com \
--cc=conor.dooley@microchip.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-riscv@lists.infradead.org \
--cc=palmer@dabbelt.com \
--cc=palmer@rivosinc.com \
--cc=paul.walmsley@sifive.com \
--cc=songshuaishuai@tinylab.org \
--cc=sunilvl@ventanamicro.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).