While here, we also clean up some style issues in this file.
Fix CI issue to generated changelog with tox v4
Co-Authored-By: Sahid Orentino Ferdjaoui <sahid.ferdjaoui@industrialdiscipline.com>
Change-Id: If6de005dd8229fe6f21dc103f50db083a415d7e4
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Make some revisions about the example of the
implementation of nested trace points and fix
some typos.
Change-Id: I26a791e1073a2d62bd0f1c79bc26cd898d4e2c55
This patch fixes the index and module index for the osprofiler documentation
home page.
It also updates the documents tox environments to use a docs requirements.txt
Change-Id: I880f1c28232a299f50ea9ccc2178f1444efb9a41
Introduced changes:
- pre-commit config and rules
- Add pre-commit to pep8 gate, Flake8 is covered in the pre-commit hooks.
- Applying fixes for pre-commit compliance in all code.
Also commit hash will be used instead of version tags in pre-commit to
prevend arbitrary code from running in developer's machines.
pre-commit will be used to:
- trailing whitespace;
- Replaces or checks mixed line ending (mixed-line-ending);
- Forbid files which have a UTF-8 byte-order marker (check-byte-order-marker);
- Checks that non-binary executables have a proper
shebang (check-executables-have-shebangs);
- Check for files that contain merge conflict strings (check-merge-conflict);
- Check for debugger imports and py37+ breakpoint()
calls in python source (debug-statements);
- Attempts to load all yaml files to verify syntax (check-yaml);
- Run flake8 checks (flake8) (local)
For further details about tests please refer to:
https://github.com/pre-commit/pre-commit-hooks
Change-Id: If4bd505d6bf73d06ce2f6080cedb3b5576c881d9
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Disable openstackdocs_auto_name to use 'project' variable as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: Ia700e656b4c2616ccbff32707eb4297a1dafbe3b
SQLAlchemy collector requires database JSON data type support
which is fairly new feature and missing in versions older than:
- MariaDB 10.2
- MySQL 5.7.8
Let's document that SQLAlchemy collector requirement.
Change-Id: Ifb379a40d90d252d56d4f830e75bbfa08bf66a01
Closes-Bug: #1825693
Beside the already available collectors, add a sqlalchemy based
collector. This is useful if you don't want to maintain another DB
solution and just use the (usually) already available database.
The driver currently implements the notify() and get_report() methods
so it is possible to store trace points and to get a single trace.
Change-Id: If91b35d4b97862c0ecf6677f4c6b95a09d411195
Our current Ceilometer driver relies on old version of ceilometer client,
which is in deprecated state and not compatible with the latest Telemetry
projects (Panko, Gnocchi). The functionality of the driver is not tested
automatically and most probably broken. So it's time to let it go and
clean the code.
This patch leaves "messaging" driver as default for notification and
makes "connection-string" a required parameter in CLI. In the future
we may consider to change default notification driver, though it
requires proper release note handling in all affected projects.
Change-Id: Id8442c4ff13c5cc33fd909b4757757cc5f396f50
1) Fix the invalid doc links according to the lastest OpenStack Website.
2) Replace them with the right ones.
Change-Id: I8d768802e25944a9761263cb2c80f5aaca317e96
openstackdocstheme shows vertical lines for quote blocks.
This commit removes unnecessary leading spaces.
Change-Id: Ie5651f0510550eb3910e68e433a41e99bf2bfa8a
Using a timestamp as value for "html_last_updated_fmt" isn't good
for the reproducible builds initiative from different downstream
distributions because the build result always differs due to the
timestamp in the documentation.
Also when not setting "html_last_updated_fmt", the value can be set
via command line when running "sphinx-build -D".
Change-Id: Ia23451e6b53f6f83dd22e069ef42a4a067ec5881
Add warning to indicate something is wrong when getting last updated
information from git repository.
Change-Id: Ie1ff9d77c30e4d5601443ece992968593fc1b8c1
Add actual sections and files and remove the main
index.rst just being a symlink of the README.rst file
and have that README.rst file now be formatted like the
other oslo projects.
Change-Id: I7ec12eef59bfbc2434a9905fe6e1ee4b9e3736e5
* We bump osporfiler to 0.3.1, but don't update this in README.rst,
just remove the version to avoid inconsistent.
* We get last updated time from git history, so don't set it
with specific version for document.
Change-Id: I7292cfb1f9c74ca5a8387fc4e5fff076679835a7
otherwise, when building from unchanged source in 2018,
it would claim Copyright 2018 which is not true .
Change-Id: I80d466b0e1273a50c0e8f0c4850314afd4def389
When building packages if git is absent, then we should
fall back to a safe default.
Closes-Bug: #1552251
Change-Id: I9b21700f942f5d1f9302b3af04d6d24e1afba1b3
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Change-Id: I5e8a3cb1d2a50656025ca0fec5f95b581f0af7b4
Closes-Bug: #1529836