[PATCH v2 6/6] doc: add documentation for gen_compile_commands.py

Tom Rini trini at konsulko.com
Sat Sep 2 15:49:09 CEST 2023


On Sat, Sep 02, 2023 at 03:38:13PM +0200, João Marcos Costa wrote:
> Hello,
> 
> Em sáb., 2 de set. de 2023 às 15:11, Tom Rini <trini at konsulko.com> escreveu:
> 
> >
> > This isn't included in one of the index files, which will be the first
> > error 'make htmldocs' throws, and I think I saw other syntax errors as
> > well in the file.  The docs themselves look fine, thanks.
> >
> > --
> > Tom
> >
> 
> I'm not sure what's the most pertinent category in 'develop/index.rst'.
> 
> Would 'general' be a good idea? I thought about putting it in the same
> category as checkpatch, but this isn't refactoring per se.

So, the main use case is to make integration with IDEs easier? Maybe put
it under doc/build/ or referenced from doc/build/tools.rst with a small
section like "Integration with IDEs" and a few words about how some IDEs
such as ... use Clangd LSP for ... and see :doc:... for more
information on how to generate these files.

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20230902/a90e8d74/attachment.sig>


More information about the U-Boot mailing list