Re: [PATCH] docs: Integrate rustdoc into Rust documentation

From: Carlos Bilbao
Date: Fri Dec 02 2022 - 11:31:39 EST


On 12/2/22 10:27, Miguel Ojeda wrote:

On Thu, Dec 1, 2022 at 9:40 PM Carlos Bilbao <carlos.bilbao@xxxxxxx> wrote:
I don't understand config sync. Perhaps that, e.g. Documentation/Makefile
checks for broken docs, for CONFIG_WARN_MISSING_DOCUMENTS, but we don't
do that for rust/Makefile? I'm not sure, but it does sound orthogonal, yes.
Config sync is what needs to happen to make a bunch of files in
`include/` up to date with respect to the `.config`. It runs
automatically for some targets, but not always. For instance, the
`*docs` targets do not trigger it. So if you enable e.g.
`CONFIG_WARN_MISSING_DOCUMENTS`, and immediately afterwards run
`htmldocs`, it will not take it into account.

But don't worry about it: that part of my comment was directed at
others (e.g. Jon, Akira...) that may know the historical context or
the reason behind it -- no need to fix it here. I mentioned it here
since it affects `CONFIG_RUST` if we use it there (in the same way as
the other `CONFIG_*` used there).


Ah, that makes sense. I appreciate the clarification!



Cheers,
Miguel


Thanks,
Carlos