Fix #7276: cpp: objects generate hypertarget names unexpectedly

[tk0miya]

Feature or Bugfix

• Bugfix
• Refactoring

Purpose

• refs: cpp: objects generate hypertarget names unexpectedly #7276
• I think this would not be an expected behavior. So I'm going to remove signode['names'] assignment. Is my understand correct?
• I also thought to change node_id generation mechanism to use make_id(). But cpp domain is too complicated to me. And it seems it already has its own ID generation engine. So it does not cause a problem like some domain directives generate wrong target ID #6903. So I'd like to keep as is now.

@jakobandersen Could you review this and give an advice to me.

[codecov]

Codecov Report

Merging #7277 into 3.x will increase coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              3.x    #7277      +/-   ##
==========================================
+ Coverage   84.01%   84.05%   +0.04%     
==========================================
  Files         281      279       -2     
  Lines       43398    43221     -177     
  Branches     6329     6299      -30     
==========================================
- Hits        36459    36328     -131     
+ Misses       5559     5520      -39     
+ Partials     1380     1373       -7

Impacted Files	Coverage Δ
sphinx/domains/cpp.py	80.6% <ø> (-0.01%)	⬇️
sphinx/__init__.py
sphinx/theming.py

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2b6f06b...22084ad. Read the comment docs.

[jakobandersen]

Hmm, I can reproduce the warning this is supposed to fix, but I don't actually know where it comes from. Do you know where it is generated from? (perhaps inside docutils?) In short: besides avoiding the warning I'm actually not sure what the specific effect of removing this line is.

[tk0miya]

Yes, the warning came from inside docutils.

In short: besides avoiding the warning I'm actually not sure what the specific effect of removing this line is.

In docutils world, node['names'] is used to create a hyperlink target that is able to refer via its name. On the other hand, Sphinx provides some roles (ex. :cpp:func:) to realize the cross-reference feature because docutils does not support a reference between multiple documents. Therefore, it is not needed to generate names for the hyperlink target.

[jakobandersen]

Thanks, looks good to merge.

[jakobandersen]

• I also thought to change node_id generation mechanism to use make_id(). But cpp domain is too complicated to me. And it seems it already has its own ID generation engine. So it does not cause a problem like some domain directives generate wrong target ID #6903. So I'd like to keep as is now.

Indeed. IDs are generated from the declaration such that clashes can never happen (assuming no bugs). As features are added there has been a need to change IDs for existing objects. There are thus multiple IDs for the same entity (currently _max_id = 4), each with their own prefix to avoid clashes (see the _id_prefix variable). This makes old links still work, though some day the oldest ones should probably be removed.

[tk0miya]

Thank you for reviewing! merged.