libvirt/docs
Jiri Denemark d317d1d217 docs: Document requirements on format strings in translated messages
Preserving the order of format strings (%s, ...) when translating
messages may be very hard or even impossible depending on the target
language. On the other hand, reordering them requires understanding the
C-format strings which is not something we should expect from
translators. And even if someone reorders format strings in the right
way (by addressing arguments directly using N$), someone else may use a
translation tool that requires format strings in msgid and msgstr to
match exactly and forces these correct formats to be reverted.

As a result of this, we had several reported crashes in some locales
because integers were formatted as strings. So to make such crashes less
likely to happen and to make translating our messages easier, we now
require all messages that are marked for translation to use format
strings that always refer to the same argument no matter where they
appear in a message (e.g., %1$s, %5$llu).

Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2023-04-01 11:40:31 +02:00
..
css docs: Convert 404 page to rST 2023-02-21 10:58:59 +01:00
fonts docs: Move font definitions with other CSS files 2022-01-04 15:47:28 +01:00
gitdm gitdm: Add other email into Red Hat company list 2021-10-12 16:46:45 +02:00
go meson: Replace meson.build_root() with meson.project_build_root() 2022-10-10 15:06:09 +02:00
html docs|access: Don't build the ACL flags into a separate XML 2023-03-06 13:09:16 +01:00
images docs: Drop node.gif 2022-01-21 10:17:11 +01:00
js docs: Fix searching in the wiki 2023-03-13 17:11:17 +01:00
kbase Fix some typos 2023-03-09 14:09:16 +01:00
logos docs: logos: Turn 'README' into rST, generate an index and link to images 2023-02-15 12:38:45 +01:00
manpages manpages: fix secret injection example for SEV 2023-03-17 15:45:33 +00:00
404.rst docs: Convert 404 page to rST 2023-02-21 10:58:59 +01:00
acl.html.in docs: ACL: Show which permissions are allowed for unauthenticated connections 2023-02-20 09:22:51 +01:00
aclpolkit.rst docs: html.in: Convert aclpolkit to rst 2021-03-15 17:31:35 +01:00
advanced-tests.rst lib: Drop internal virXXXPtr typedefs 2021-04-13 17:00:38 +02:00
android-chrome-192x192.png
android-chrome-256x256.png
api_extension.rst docs: Update obsolete reference to formatdomain.html.in 2022-03-22 11:05:09 +01:00
api.rst docs: Remove extra leading slash in 'api' and 'formatdomaincaps' pages 2022-06-01 12:27:10 +02:00
apple-touch-icon.png
apps.rst Add vms cli tool to the list of applications using libvirt 2022-11-17 08:00:03 +01:00
auditlog.rst docs: html.in: Convert auditlog to rst 2021-03-15 17:31:57 +01:00
auth.rst docs: auth: Fix a couple of stylistic issues 2021-03-23 17:55:06 +01:00
best-practices.rst docs: Update best practices wrt "Fixes:" and GitLab 2022-10-25 08:37:28 +02:00
bindings.rst docs: update links to listman 2022-06-22 15:29:44 +02:00
browserconfig.xml
bugs.rst docs: bugs: Remove raw HTML anchor 'quality' 2022-04-25 16:33:01 +02:00
cgroups.rst docs: Convert 'cgroups' page to rST 2022-04-01 16:33:19 +02:00
ci-dashboard.rst docs: Move the CI dashboard to its own RST module 2022-07-14 17:31:21 +02:00
ci-runners.rst docs: Provide an article on how to add a custom runner to the project 2022-07-14 17:31:21 +02:00
ci.rst docs: ci: Add a brief section on how to run the CI workload locally 2022-07-15 08:26:38 +02:00
coding-style.rst docs: Document requirements on format strings in translated messages 2023-04-01 11:40:31 +02:00
committer-guidelines.rst meson: adjust our documentation to mention meson instead of autoconf 2020-08-03 09:27:09 +02:00
compiling.rst docs: compiling: Add link to latest openSUSE libvirt package 2022-09-30 09:05:59 -06:00
contact.rst docs: update links to listman 2022-06-22 15:29:44 +02:00
contribute.rst docs: contact: Remove HTML anchors and adjust documents using them 2022-04-25 16:33:01 +02:00
csharp.rst docs: convert 'csharp' page to rst 2022-04-07 15:10:26 +02:00
daemons.rst docs: Move 'tlscerts' page to 'kbase/' 2022-04-07 15:10:26 +02:00
dbus.rst docs: convert 'dbus' page to rst 2022-04-07 15:10:26 +02:00
docs.rst docs: logos: Turn 'README' into rST, generate an index and link to images 2023-02-15 12:38:45 +01:00
downloads.rst docs: downloads: Point to pkg.go.dev for go module releases 2023-03-14 15:42:36 +01:00
drivers.rst docs: drivers: Mention KVM/HVF in the link of qemu driver 2022-05-19 10:10:31 +02:00
drvbhyve.rst docs: drvbhve: Fix local anchor links 2022-04-19 16:19:48 +02:00
drvch.rst Add basic driver for the Cloud-Hypervisor 2021-06-04 10:56:06 +01:00
drvesx.rst Correct links to TLS certificate setup page 2022-04-25 16:33:01 +02:00
drvhyperv.rst docs: Update various URLs 2022-05-24 12:19:16 +02:00
drvlxc.rst docs: formatdomain: Remove 'elementsOSContainer' anchor 2022-06-01 12:27:09 +02:00
drvnodedev.rst docs: Convert 'formatnode' page to rst 2022-04-19 16:19:48 +02:00
drvopenvz.rst docs: Convert 'drvopenvz' page to rST 2022-04-01 16:33:19 +02:00
drvqemu.rst docs: drvqemu: Fix a typo 2023-01-12 11:40:21 +01:00
drvsecret.rst docs: Convert 'drvsecret' page to rST 2022-04-01 16:33:19 +02:00
drvtest.rst docs: Convert 'drvtest' page to rST 2022-04-01 16:33:19 +02:00
drvvbox.rst vbox: Drop support for virtualbox-6.0.0 2023-01-24 10:24:07 +01:00
drvvirtuozzo.rst docs: Convert 'drvvirtuozzo' page to rST 2022-04-01 16:33:19 +02:00
drvvmware.rst docs: Convert 'drvvmware' page to rST 2022-04-01 16:33:19 +02:00
drvxen.rst docs: Convert 'drvxen' page to rST 2022-04-01 16:33:19 +02:00
errors.rst docs: Convert 'errors' page to rST 2022-03-08 17:40:47 +01:00
favicon-16x16.png
favicon-32x32.png
favicon.ico
firewall.rst docs: Convert 'formatnwfilter' page to rst 2022-04-19 16:19:48 +02:00
format.rst docs: Convert 'format' page to rST 2022-04-01 16:33:19 +02:00
formatbackup.rst docs: formatdomain: Remove 'elementsDisks' anchor 2022-06-01 12:27:09 +02:00
formatcaps.rst formatcaps: Update capabilities example 2022-12-12 17:08:07 +01:00
formatcheckpoint.rst docs: formatdomain: Remove 'elementsDisks' anchor 2022-06-01 12:27:09 +02:00
formatdomain.rst docs: Document memory allocation and emulator pinning limitation 2023-03-15 12:47:09 +01:00
formatdomaincaps.rst capabilities: introduce crypto device 2023-01-25 16:00:47 +01:00
formatnetwork.rst docs: fix syntax errors in IPv6 NAT example XML 2022-08-23 16:33:20 +01:00
formatnetworkport.rst docs: formatdomain: Remove 'elementsNICSDirect' anchor 2022-06-01 12:27:09 +02:00
formatnode.rst schema: nodedev: Fix schema attribute value for the 'vport_ops' capability 2022-09-01 13:11:09 +02:00
formatnwfilter.rst docs: Convert 'formatnwfilter' page to rst 2022-04-19 16:19:48 +02:00
formatsecret.rst docs: formatdomain: Remove 'elementsTpm' anchor 2022-06-01 12:27:10 +02:00
formatsnapshot.rst docs: formatdomain: Remove 'seclabel' anchor 2022-06-01 12:27:10 +02:00
formatstorage.rst Remove support for building the sheepdog storage driver backend 2022-09-01 13:11:09 +02:00
formatstoragecaps.rst docs: Convert 'formatstoragecaps' page to rST 2022-04-07 17:15:52 +02:00
formatstorageencryption.rst qemu: add luks-any encryption support for RBD images 2023-03-16 15:19:36 +01:00
glib-adoption.rst docs: glib-adoption: add string arrays and objects 2020-10-02 14:10:44 +02:00
goals.rst docs: Convert 'goals' to rST 2022-03-08 17:40:47 +01:00
golang.rst docs: Add sub-page for all golang modules 2023-02-15 12:38:45 +01:00
governance.rst docs: governance: Remove unused HTML anchors 2022-04-25 16:33:01 +02:00
hacking.rst Drop YouCompleteMe and color_coded integration 2022-03-17 14:35:05 +01:00
hooks.rst docs: Recommend better python3 shebang 2023-02-20 18:33:01 +01:00
index.html.in docs: Add support page for libvirt on macOS 2022-01-25 16:54:44 +01:00
issue-handling.rst docs: Add article about handling upstream issues 2022-07-26 16:35:57 +02:00
java.rst docs: java: Clean up links to source code 2023-03-14 15:42:36 +01:00
libvirt-go-xml.rst docs: introduce stubs for new libvirt Go packages 2021-06-07 17:04:14 +01:00
libvirt-go.rst docs: introduce stubs for new libvirt Go packages 2021-06-07 17:04:14 +01:00
logging.rst docs: logging: Replace example by link to kbase/debuglogs.html 2022-04-01 16:33:20 +02:00
macos.rst docs: Add support page for libvirt on macOS 2022-01-25 16:54:44 +01:00
manifest.json
meson.build scripts/apibuild: Extract and format API ACLs 2023-03-06 13:09:16 +01:00
migration.rst docs: Move all images to a subdirectory 2022-01-04 15:47:25 +01:00
mstile-150x150.png
newapi.xsl docs/newapi.xsl: Take API flag data from libvirt-api.xml rather than access/libvirt-access.xml 2023-03-06 13:09:16 +01:00
newreposetup.rst docs: Document CIRRUS_GITHUB_REPO variable 2020-06-11 12:03:41 +02:00
nss.rst docs: Convert 'nss' page to rST 2022-03-10 17:52:07 +01:00
page.xsl docs: XSL: Add source document name as custom data attribute for <html> 2023-02-15 12:38:45 +01:00
pci-addresses.rst Fix spelling 2021-04-15 15:42:21 +02:00
pci-hotplug.rst docs: pci-hotplug: Fix local anchor links 2022-04-19 16:19:48 +02:00
php.rst docs: Convert 'php' page to rST 2022-04-01 16:33:20 +02:00
platforms.rst docs: Fix spelling for Homebrew 2022-04-14 11:54:28 +02:00
programming-languages.rst Fix capitalization "CLang" -> "Clang" 2020-11-12 15:01:42 +01:00
python.rst docs: convert 'python' page to rst 2022-04-07 15:10:26 +02:00
remote.rst docs: remote: Fix anchor names in links to uri.html 2022-06-01 12:27:10 +02:00
securityprocess.rst docs: contact: Remove HTML anchors and adjust documents using them 2022-04-25 16:33:01 +02:00
site.xsl docs: Simplify passing of 'href_base' XSL variable 2022-04-12 12:53:32 +02:00
storage.rst Remove support for building the sheepdog storage driver backend 2022-09-01 13:11:09 +02:00
strategy.rst docs: Convert 'strategy' to rST 2022-03-08 17:40:47 +01:00
styleguide.rst
submitting-patches.rst docs: submitting-patches: remove note about --patience 2023-01-20 22:12:42 +01:00
support.rst docs: Convert 'support' page to rST 2022-03-08 17:40:47 +01:00
testapi.rst docs: Convert 'testapi' page to rST 2022-03-10 17:52:07 +01:00
testing.rst docs: Fix typos 2022-07-18 11:10:55 +02:00
testtck.rst docs: Fix typos 2022-07-18 11:10:55 +02:00
uri.rst uri: Fix link to qemu KVM example config 2022-06-01 12:27:10 +02:00
windows.rst docs: Update URL for MinGW 2022-05-24 12:19:15 +02:00