delta/libvirt.git/scripts, branch master

build: Add checks for permutable format strings

2023-04-01T09:40:36+00:00

Since all messages marked for translation contain permutable format
strings, we can add checks for enforcing them.

The syntax check does not catch all cases as it only checks format
strings between _(" and the first ". In other words messages where \"
appears before the first format string or multi-line messages where the
first format strings is not in the first line will not be checked. On
the other hand, it's run automatically by "meson test".

check-pot.py python script will detect all incorrect format strings, but
it's not as easy to use as it requires libvirt.pot to be regenerated and
this does not happen during a standard build. The following steps are
needed to check messages with check-pot.py:

    meson compile libvirt-pot-dep
    meson compile libvirt-pot
    meson compile libvirt-pot-check

Don't forget to revert changes to libvirt.pot if you run these commands
locally as we don't want each patch series to update libvirt.pot.

Shell scripts (tools/libvirt-guests.sh.in is the only one currently)
need to be exempt from this check as shell's printf function does not
understand the permutable format strings.

Signed-off-by: Jiri Denemark 
Reviewed-by: Daniel P. Berrangé

scripts/apibuild: Extract and format API ACLs

2023-03-06T12:09:16+00:00

As an additional step before processing the API parse the protocol file
and extract all ACL definitions. This way we can distribute them for any
user of the libvirt API XML files. We will be also able to avoid another
call to gendispatch, which generates all this data into a standalone
XML.

The remote procedure to API name is inspired by what rpcgen does.

Signed-off-by: Peter Krempa 
Reviewed-by: Ján Tomko

apibuild: Add infrastructure for generating ACL flag info into function docs

2023-03-06T12:09:15+00:00

If the user of the 'docBuilder' class provides a dict (key is API name,
value is a tuple of arrays (acls, aclfilters), use the dict to generate
ACL definitions into the function definition.

Signed-off-by: Peter Krempa 
Reviewed-by: Ján Tomko

docs: ACL: Mention the ACL object name along with the corresponding libvirt object name

2023-02-20T17:26:47+00:00

It's not trivial to figure out the ACL object name from our
documentation. Add it above the table outlining existing permissions.

Signed-off-by: Peter Krempa 
Reviewed-by: Daniel P. Berrangé

docs: Fix generated names for ACL objects

2023-02-20T17:26:16+00:00

Both the object name and permission name in ACL use '-' instead of '_'
separator when referring to them in the docs or even when used inside of
polkit. Unfortunately the generators used for generating our docs don't
honour this in certain cases which would result in broken names in the
API docs (once they will be generated).

Rename both object and permission name to use dash and reflect that in
the anchor names in the documentation.

Signed-off-by: Peter Krempa 
Reviewed-by: Ján Tomko

docs: ACL: Show which permissions are allowed for unauthenticated connections

2023-02-20T08:22:51+00:00

Certain APIs are allowed also without authentication but the ACL page
didn't outline which. Generate a new column with the information.

Signed-off-by: Peter Krempa 
Reviewed-by: Daniel P. Berrangé

scripts: check-html-refernces: Add checking for image file usage

2023-02-15T11:38:45+00:00

Check both that a file is referenced from our pages and also that pages
reference existing images.

The mode for dumping external references now also dumps images.

'--ignore-image' can be used repeatedly to suppress errors for specific
images.

Signed-off-by: Peter Krempa 
Reviewed-by: Daniel P. Berrangé

scripts: check-html-references: Detect pages that are not linked to

2023-02-15T11:38:45+00:00

Prevent sub-pages without a way to reach them.

Signed-off-by: Peter Krempa 
Reviewed-by: Daniel P. Berrangé

scripts: check-html-references: Improve error messages and don't mess with relative paths

2023-02-15T11:38:45+00:00

Now that we have the source file name as a custom attribute we can use
it to report which file actually needs to be edited to fix the error:

 ERROR: 'docs/uri.rst': broken link to: 'drvqemu.html#exaple'

rather than:

 broken link targets:
 docs/uri.html broken link: drvqemu.html#exaple

which pointed to file which does not exist in the source directory.

This also allows us to delete all the relative path handling needed to
report at least somewhat user-legible errors before.

Signed-off-by: Peter Krempa 
Reviewed-by: Daniel P. Berrangé

scripts: check-html-references: Rename --prefix to --webroot and make it mandatory

2023-02-15T11:38:45+00:00

Force users to pass the path to the root of the webpage the script
should check. The script lives in a different subdirectory so the
default of the current directory doesn't make much sense.

Signed-off-by: Peter Krempa 
Reviewed-by: Daniel P. Berrangé