Python 3.12 emits SyntaxWarning for invalid escape sequences in ordinary
string literals. The re.search() call on line 162 was the only pattern
in the file passed as a non-raw string, causing:
doc/scripts/gen_state_diagram.py:162: SyntaxWarning: invalid escape
sequence '\s'
i = re.search("return\s+transit<\s*(\w*)\s*>()", line)
Add the r"" prefix to match the other re.search / re.finditer / re.sub
call sites in the same file. No behavior change; \s was already being
interpreted as a regex whitespace class because Python leaves unknown
escapes untouched, but this will become a SyntaxError in a future
Python release.
Signed-off-by: Kefu Chai <k.chai@proxmox.com>
so we can build the command doc using ReadTheDoc infra, without adding
the generated rst file to the source repo.
before this change, all the commands are ordered alphabetically. after
this change, command docs are generated by two directives, and are
ordered separately. we could restructure the directives and merge them.
but let's leave it for a future change if this is important.
for more details on writing sphinx directives, see
https://www.sphinx-doc.org/en/master/extdev/markupapi.html and
https://docutils.sourceforge.io/docs/howto/rst-directives.html
Signed-off-by: Kefu Chai <kchai@redhat.com>
In python3.8 comparing strings using 'is' and 'is not' throws syntax warning.
Instead use equality operator.
Signed-off-by: Varsha Rao <varao@redhat.com>
So that signatures can get parsed when they are split like:
PG::RecoveryState::RepWaitBackfillReserved::react(
const RemoteReservationCanceled &evt)
Signed-off-by: Alfredo Deza <adeza@redhat.com>
When applying ceph patches, some warnings reported, e.g.
doc/scripts/gen_state_diagram.py:99: trailing whitespace.
Signed-off-by: Li Peng <lip@dtdream.com>
The /usr/bin/python hashbang causes doc builds to fail when Python3 is
the default Python and Python2 is being used from within a virtualenv or
Pythonbrew environment.
Signed-off-by: Sharif Olorin <sio@tesser.org>
