Hi Jonathan, On Fri, Jun 23, 2023 at 3:44 PM Jonathan Corbet <corbet@xxxxxxx> wrote: > > Alexandre Ghiti <alexghiti@xxxxxxxxxxxx> writes: > > > This document describes the constraints and requirements of the early > > boot process in a RISC-V kernel. > > Some quick comments... > > > +The RISC-V kernel expects: > > + > > + * `$a0` to contain the hartid of the current core. > > + * `$a1` to contain the address of the devicetree in memory. > > Single `backtick` quotes are probably not doing what you want. If > you're looking for it to render in a monospace font, use ``double`` > quotes instead. But I'd also encourage you to keep that to a minimum to > avoid overly cluttering the plain-text document. Indeed, the rendering is better with double quotes, thanks. > > [...] > > > +Virtual mapping installation > > +---------------------------- > > + > > +The installation of the virtual mapping is done in 2 steps in the RISC-V kernel: > > + > > +1. :c:func:`setup_vm` installs a temporary kernel mapping in > > 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? > > > + :c:var:`early_pg_dir` which allows discovery of the system memory. Only the > > We also really just don't use :c:var: at all. Kerneldoc doesn't > currently know about global variables...perhaps it should but that's not > the way of things now. Ok, noted, I remove those "c:XXX". Thanks > > Thanks, > > jon >
