search

phytec / doc-bsp-yocto

Yocto BSP Documentation
https://phytec.github.io/doc-bsp-yocto/
1 stars 1 forks source link

Add config file for rstcheck #187

Closed ymoog closed 5 months ago

ymoog commented 5 months ago

I am using rstcheck as a static analysis tool. Add an initial config file for the analyzer to ignore substitutions it cannot handle. These are enhanced/custom ones introduced by sphinx extensions.

ymoog commented 5 months ago

I'd like to avoid tracking unused (regarding the source code) files in this repository.

Makes sense to me.

IMHO, you are better off saving this config e.g. in your personal dotfiles. I hope, I don't come across as mean now. 😬 Kind regards!

In the user configs goes general stuff. What I add is project specific and thus should go in the project directory.

If it is unacceptable to you to have this config tracked, my suggestion is to have it added to gitignore instead.

mschwan-phytec commented 5 months ago

In the user configs goes general stuff. What I add is project specific and thus should go in the project directory.

True. I am not familiar with rstcheck specifically, but maybe it allows for storing a global config applying to all projects. That was my thinking.

If it is unacceptable to you to have this config tracked, my suggestion is to have it added to gitignore instead.

That's okay for me, although the same applies here: We do not want to add all possible files to ignore in .gitignore. But I think we can keep it clear and a few lines there won't hurt. :+1:

mschwan-phytec commented 5 months ago

I'm closing this then, as I think we came to a common ground.

@ymoog Please open a separate PR, if you want the rstcheck config added to .gitignore.