proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-05-29 18:44:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

asciidoc-pve.in: detect and avoid xrefs spanning multiple lines

Browse Source 
Because our parser is not smart enough to do it better.
This commit is contained in:
Dietmar Maurer 2016-10-21 07:06:36 +02:00
parent fd02ab9033
commit 7d48940bf0
3 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
asciidoc-pve.in
View File

@ -234,6 +234,12 @@ sub prepare_adoc_file {
next; next;
} }
if ($line =~ m/xref:\S+?\[[^\]]*$/) {
die "possible xref spanning multiple lines in '$filename':\n(line $.): $line\n";
}
if ($line =~ m/<<((?!\>\>).)*$/) {
die "possible xref spanning multiple lines in '$filename':\n(line $.): $line\n";
}
# fix xrefs # fix xrefs
$line =~ s/xref:([^\s\[\]]+)\[([^\]]*)\]/replace_xref(${target_env},$1,$2)/ge; $line =~ s/xref:([^\s\[\]]+)\[([^\]]*)\]/replace_xref(${target_env},$1,$2)/ge;

9
pvecm.adoc
View File

@ -666,8 +666,9 @@ RRP On A Created Cluster
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
When enabling an already running cluster to use RRP you will take similar steps When enabling an already running cluster to use RRP you will take similar steps
as describe in <<separate-cluster-net-after-creation,separating the cluster as describe in
network>>. You just do it on another ring. <<separate-cluster-net-after-creation,separating the cluster network>>. You
just do it on another ring.
First add a new `interface` subsection in the `totem` section, set its First add a new `interface` subsection in the `totem` section, set its
`ringnumber` property to `1`. Set the interfaces `bindnetaddr` property to an `ringnumber` property to `1`. Set the interfaces `bindnetaddr` property to an
@ -722,8 +723,8 @@ nodelist {
---- ----
Bring it in effect like described in the <<edit-corosync-conf,edit the Bring it in effect like described in the
corosync.conf file>> section. <<edit-corosync-conf,edit the corosync.conf file>> section.
This is a change which cannot take live in effect and needs at least a restart This is a change which cannot take live in effect and needs at least a restart
of corosync. Recommended is a restart of the whole cluster. of corosync. Recommended is a restart of the whole cluster.

14
pveum.adoc
View File

@ -295,7 +295,7 @@ We use file system like paths to address these objects. These paths form a
natural tree, and permissions of higher levels (shorter path) can natural tree, and permissions of higher levels (shorter path) can
optionally be propagated down within this hierarchy. optionally be propagated down within this hierarchy.
[[templated-paths]] [[pveum_templated_paths]]
Paths can be templated. When an API call requires permissions on a Paths can be templated. When an API call requires permissions on a
templated path, the path may contain references to parameters of the API templated path, the path may contain references to parameters of the API
call. These references are specified in curly braces. Some parameters are call. These references are specified in curly braces. Some parameters are
@ -310,7 +310,7 @@ Some examples are:
* `/vms`: Covers all VMs * `/vms`: Covers all VMs
* `/vms/{vmid}`: Access to specific VMs * `/vms/{vmid}`: Access to specific VMs
* `/storage/{storeid}`: Access to a storages * `/storage/{storeid}`: Access to a storages
* `/pool/{poolname}`: Access to VMs part of a <<resource-pools,pool> * `/pool/{poolname}`: Access to VMs part of a <<pveum_pools,pool>>
* `/access/groups`: Group administration * `/access/groups`: Group administration
* `/access/realms/{realmid}`: Administrative access to realms * `/access/realms/{realmid}`: Administrative access to realms
@ -350,8 +350,9 @@ tree of logic and access-check functions:
Each(`and`) or any(`or`) further element in the current list has to be true. Each(`and`) or any(`or`) further element in the current list has to be true.
`["perm", <path>, [ <privileges>... ], <options>...]`:: `["perm", <path>, [ <privileges>... ], <options>...]`::
The `path` is a templated parameter (see <<templated-paths,Objects and The `path` is a templated parameter (see
Paths>>). All (or , if the `any` option is used, any) of the listed <<pveum_templated_paths,Objects and Paths>>). All (or , if the `any`
option is used, any) of the listed
privileges must be allowed on the specified path. If a `require-param` privileges must be allowed on the specified path. If a `require-param`
option is specified, then its specified parameter is required even if the option is specified, then its specified parameter is required even if the
API call's schema otherwise lists it as being optional. API call's schema otherwise lists it as being optional.
@ -382,8 +383,9 @@ associated with a realm, since user IDs are passed in the form of
`<username>@<realm>`. `<username>@<realm>`.
`["perm-modify", <path>]`:: `["perm-modify", <path>]`::
The `path` is a templated parameter (see <<templated-paths,Objects and The `path` is a templated parameter (see
Paths>>). The user needs either the `Permissions.Modify` privilege, or, <<pveum_templated_paths,Objects and Paths>>). The user needs either the
`Permissions.Modify` privilege, or,
depending on the path, the following privileges as a possible substitute: depending on the path, the following privileges as a possible substitute:
+ +
* `/storage/...`: additionally requires 'Datastore.Allocate` * `/storage/...`: additionally requires 'Datastore.Allocate`