domain: c: fix warning for intersphinx targets#8418
domain: c: fix warning for intersphinx targets#8418utzig wants to merge 1 commit intosphinx-doc:3.xfrom
Conversation
Referencing a symbol using <project:symbol>, which is a valid syntax that can be resolved by intersphinx, results in the C-domain parser printing a warning "Unparseable C cross-reference". The resolution still works correctly because it is postponed to intersphinx. This commit adds a small check for intersphinx target format validity before printing the warning. Signed-off-by: Fabio Utzig <[email protected]>
|
Hmm, do you have a small example project where this helps? |
I just built this little toy project which shows the issue. It has 3 projects, two of them, proj1 and proj2, export a function named "fn". In the "main" project I try to link to "fn". It will always link correctly to one of the "fn" functions, but there is no control over which. If I use "proj1:fn" or "proj2:fn" than it will link to the one I want, but will throw a "Unparseable C cross-reference: bla bla bla" warning on the way. |
|
@jakobandersen Have you had a chance to look into this? |
|
I find this way of making it work a bit iffy: when you write any kind of role in your input you are requesting a specific handler to be invoked, e.g., for :inter:`proj1,c:func,fn`where the three comma-separated components are
|
|
FYI: Now I just posted a draft version of the |
Referencing a symbol using project:symbol, which is a valid syntax that can be resolved by intersphinx, results in the C-domain parser printing a warning "Unparseable C cross-reference". The resolution still works correctly because it is postponed to intersphinx.
This commit adds a small check for intersphinx target format validity before printing the warning.
/cc @jakobandersen