Sphinx: glossary duplicate term with a different case

[williamdes]

Describe the bug

Warning, treated as error:
doc/glossary.rst:243:duplicate term description of mysql, other instance in glossary

To Reproduce
Steps to reproduce the behavior:
.travis.yml#L168

$ git clone --depth 1 https://github.com/phpmyadmin/phpmyadmin.git
$ cd doc
$ pip install 'Sphinx'
$ make html

Expected behavior
MySQL != mysql term right ?

Your project
https://github.com/phpmyadmin/phpmyadmin/blame/master/doc/glossary.rst#L234

Environment info

• OS: Unix
• Python version: 3.6
• Sphinx version: 3.0.0

Additional context
Did occur some hours ago, maybe you just released the version

• https://travis-ci.org/github/williamdes/phpmyadmintest/jobs/671352365#L328

[tk0miya]

Sorry for the inconvenience. Indeed, this must be a bug. I'll take a look this later.

[williamdes]

Thank you for fixing it, let me know when a release it done so I can restart my builds

[tk0miya]

@williamdes Please follow #7453. I'll work for release maybe tomorrow.

[williamdes]

Thank you :rocket:
From the PR I could see linked, did you add a test case for what I sent ?

MySQL
   blablabla

mysql
   blablabla duplicate in lowercase

[tk0miya]

No. The reason of this problem is that sphinx makes the keywords downcase on storing to the internal database. So it's okay only to confirm the stored keyword is not downcased.

[williamdes]

Okay, I understand

[ankostis]

So is this change on purpose?

I mean, do we have to change the casing of all terms on all our projects testing site with -W, or e.g. travis will fail?

[tk0miya]

No, the change was not intended. And it was fixed at 3.0.1.

[ankostis]

For a project of mine, it doesn't look fixed.

See these 2 travis-builds of 2 successive commits, then only difference being the casing of the terms has been equalized.

• terms with different casing:
• terms casing all equal

You maych check the pip-list to verify that sphinx-3.0.1 it is, indeed.

[williamdes]

I only had to fix references to the glossary but not the glossary itself
https://github.com/phpmyadmin/phpmyadmin/commit/41c1e360d4c162a28e8c6f0949f47aaf467cb2cd

[jtanx]

Seems a bit crap to introduce a breaking change on a point release. This breaks resolving terms in a case insensitive fashion.

[tk0miya]

Okay, I understand what you're saying. It is also not an intended change. Now they become case-sensitive. But they should keep working. I'll work for it soon.

[tk0miya]

Now I merged #7501. It tries to search a term case-sensitively at first, and fallbacks to case-insensitive search automatically.
Thank you for reporting, all!

[stevepiercy]

@tk0miya I think this is still not fixed in Sphinx 3.0.2 per our Travis build:

https://travis-ci.org/github/Pylons/pyramid/jobs/678922303#L770

To echo @ankostis, do we have to change the word casing of all terms or do we ignore these warnings?

If we are supposed to ignore these warnings, how can we ignore just this one type?

[tk0miya]

Ah, sorry for mention it. Please set supress_warnings = ['ref.term'] in your conf.py.

[stevepiercy]

FTR, there was a typo, suppress_warnings = ['ref.term']. Alternatively, in tox.ini, "SPHINXOPTS=-W -E -D suppress_warnings=ref.term". It works now. Thank you!

[ankostis]

I tried suppress_warnings = ['ref.term'] and it suppress all term-reference errors.

In my projects i always setup a test-case detecting site-building warnings,
discovering thus any broken terms. The term-case warnings still trigger the TC to fail,
so i'm still forced to change the case (like when the term begins a new sentence).

• Would it be possible to add a new suppress-warning for term-case mismattches?
• Or to log term-case messages from WARNING-->INFO?
  (there isn't any real problem, after all)