Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

C++, fix parsing of full xrefs. #6226

Merged
merged 2 commits into from
Apr 4, 2019

Conversation

jakobandersen
Copy link
Contributor

If a full xref has a short xref as prefix, e.g., T f(), parsing would fail.

Relates

@tk0miya
Copy link
Member

tk0miya commented Mar 30, 2019

Is this critical bug?

After 2.0 release, we've changed branch model:

sphinx/CONTRIBUTING.rst

Lines 323 to 345 in 44c49f4

``master``
Development for MAJOR version.
All changes including incompatible behaviors and public API updates are
allowed.
``X.Y``
Where ``X.Y`` is the ``MAJOR.MINOR`` release. Used to maintain current
MINOR release. All changes are allowed if the change preserves
backwards-compatibility of API and features.
Only the most recent ``MAJOR.MINOR`` branch is currently retained. When a
new MAJOR version is released, the old ``MAJOR.MINOR`` branch will be
deleted and replaced by an equivalent tag.
``X.Y.Z``
Where ``X.Y.Z`` is the ``MAJOR.MINOR.PATCH`` release. Only
backwards-compatible bug fixes are allowed. In Sphinx project, PATCH
version is used for urgent bug fix.
``MAJOR.MINOR.PATCH`` branch will be branched from the ``v`` prefixed
release tag (ex. make 2.3.1 that branched from v2.3.0) when a urgent
release is needed. When new PATCH version is released, the branch will be
deleted and replaced by an equivalent tag (ex. v2.3.1).

Therefore, 2.0.1 is much better for critical bug fixes.

@codecov
Copy link

codecov bot commented Mar 30, 2019

Codecov Report

Merging #6226 into 2.0.1 will increase coverage by 0.03%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##            2.0.1    #6226      +/-   ##
==========================================
+ Coverage   83.54%   83.58%   +0.03%     
==========================================
  Files         272      272              
  Lines       39357    39369      +12     
  Branches     5868     5868              
==========================================
+ Hits        32882    32907      +25     
+ Misses       5126     5113      -13     
  Partials     1349     1349
Impacted Files Coverage Δ
sphinx/domains/cpp.py 82.91% <100%> (+0.28%) ⬆️
tests/test_domain_cpp.py 96.21% <100%> (+0.07%) ⬆️

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 8925358...dbd78ac. Read the comment docs.

@jakobandersen jakobandersen changed the base branch from 2.0 to 2.0.1 April 1, 2019 06:42
@jakobandersen
Copy link
Contributor Author

@tk0miya, thanks. It's not everything-is-broken urgent, but I have rebased it to the 2.0.1 branch to get it released sooner.

@jakobandersen jakobandersen added this to the 2.0.1 milestone Apr 4, 2019
@jakobandersen jakobandersen merged commit 81d8511 into sphinx-doc:2.0.1 Apr 4, 2019
@jakobandersen jakobandersen deleted the cpp_fix_xref_parsing branch April 4, 2019 16:56
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants