From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <pdm-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
by lore.proxmox.com (Postfix) with ESMTPS id 4AC861FF16F
for <inbox@lore.proxmox.com>; Thu, 30 Jan 2025 15:00:12 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 77FA7125A5;
Thu, 30 Jan 2025 15:00:10 +0100 (CET)
References: <20250114094828.119472-1-m.sandoval@proxmox.com>
User-agent: mu4e 1.10.8; emacs 29.4
From: Maximiliano Sandoval <m.sandoval@proxmox.com>
To: Maximiliano Sandoval <m.sandoval@proxmox.com>
Date: Thu, 30 Jan 2025 15:00:01 +0100
In-reply-to: <20250114094828.119472-1-m.sandoval@proxmox.com>
Message-ID: <s8o8qqsieqg.fsf@proxmox.com>
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results: 0
AWL -0.299 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
DMARC_MISSING 0.1 Missing DMARC policy
KAM_ASCII_DIVIDERS 0.8 Email that uses ascii formatting dividers and possible
spam tricks
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
Validity was blocked. See
https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
information.
RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
Validity was blocked. See
https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
information.
RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
Validity was blocked. See
https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
information.
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
Subject: Re: [pdm-devel] [PATCH proxmox-api-types] docs: escape HTML
delimiters
X-BeenThere: pdm-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Datacenter Manager development discussion
<pdm-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pdm-devel>,
<mailto:pdm-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pdm-devel/>
List-Post: <mailto:pdm-devel@lists.proxmox.com>
List-Help: <mailto:pdm-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel>,
<mailto:pdm-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox Datacenter Manager development discussion
<pdm-devel@lists.proxmox.com>
Cc: pdm-devel@lists.proxmox.com
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pdm-devel-bounces@lists.proxmox.com
Sender: "pdm-devel" <pdm-devel-bounces@lists.proxmox.com>
Maximiliano Sandoval <m.sandoval@proxmox.com> writes:
> Fixes:
>
> $ cargo doc --all-features --workspace
> warning: unresolved link to `acdn`
> --> pve-api-types/src/types/../generated/types.rs:3780:5
> |
> 3780 | / /// The guest will attempt to boot from devices in the order they appear
> 3781 | | /// here.
> 3782 | | ///
> 3783 | | /// Disks, optical drives and passed-through storage USB devices will be
> ... |
> 3792 | | ///
> 3793 | | /// Overrides the deprecated 'legacy=[acdn]*' value when given.
> | |___________________________________________________________________^
> |
> = note: the link appears in this line:
>
> Overrides the deprecated 'legacy=[acdn]*' value when given.
> ^^^^
> = note: no item named `acdn` in scope
> = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
> = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
>
> warning: unclosed HTML tag `nodename`
> --> pve-api-types/src/types/../generated/types.rs:272:5
> |
> 272 | / /// Unique identifier for this metric object, for instance 'node/<nodename>'
> 273 | | /// or 'qemu/<vmid>'.
> | |_________________________^
> |
> = note: `#[warn(rustdoc::invalid_html_tags)]` on by default
>
> warning: unclosed HTML tag `vmid`
> --> pve-api-types/src/types/../generated/types.rs:272:5
> |
> 272 | / /// Unique identifier for this metric object, for instance 'node/<nodename>'
> 273 | | /// or 'qemu/<vmid>'.
> | |_________________________^
>
> warning: unclosed HTML tag `ostype`
> --> pve-api-types/src/types/../generated/types.rs:2061:1
> |
> 2061 | / /// OS type. This is used to setup configuration inside the container, and
> 2062 | | /// corresponds to lxc setup scripts in
> 2063 | | /// /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to
> 2064 | | /// skip and OS specific setup.
> | |_______________________________^
>
> warning: unclosed HTML tag `type`
> --> pve-api-types/src/client/mod.rs:35:10
> |
> 35 | /// For "<type>-list" entries we turn an array into a string ready for perl's `split_list()` call.
>
> Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
> ---
> pve-api-types/src/client/mod.rs | 2 +-
> pve-api-types/src/generated/types.rs | 8 ++++----
> 2 files changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/pve-api-types/src/client/mod.rs b/pve-api-types/src/client/mod.rs
> index 8832272..0de7cc3 100644
> --- a/pve-api-types/src/client/mod.rs
> +++ b/pve-api-types/src/client/mod.rs
> @@ -32,7 +32,7 @@ pub fn add_query_bool(query: &mut String, separator: &mut char, name: &str, valu
> }
> }
>
> -/// For "<type>-list" entries we turn an array into a string ready for perl's `split_list()` call.
> +/// For `<type>-list` entries we turn an array into a string ready for perl's `split_list()` call.
> pub fn add_query_arg_string_list<T>(
> query: &mut String,
> separator: &mut char,
> diff --git a/pve-api-types/src/generated/types.rs b/pve-api-types/src/generated/types.rs
> index b6a3d20..0532dc6 100644
> --- a/pve-api-types/src/generated/types.rs
> +++ b/pve-api-types/src/generated/types.rs
> @@ -269,8 +269,8 @@ pub struct ClusterMetrics {
> /// Object.
> #[derive(Debug, serde::Deserialize, serde::Serialize)]
> pub struct ClusterMetricsData {
> - /// Unique identifier for this metric object, for instance 'node/<nodename>'
> - /// or 'qemu/<vmid>'.
> + /// Unique identifier for this metric object, for instance `node/<nodename>`
> + /// or `qemu/<vmid>`.
> pub id: String,
>
> /// Name of the metric.
> @@ -2174,7 +2174,7 @@ serde_plain::derive_fromstr_from_deserialize!(LxcConfigNetType);
> #[api]
> /// OS type. This is used to setup configuration inside the container, and
> /// corresponds to lxc setup scripts in
> -/// /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to
> +/// `/usr/share/lxc/config/<ostype>.common.conf`. Value 'unmanaged' can be used to
> /// skip and OS specific setup.
> #[derive(Clone, Copy, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)]
> pub enum LxcConfigOstype {
> @@ -3910,7 +3910,7 @@ pub struct PveQmBoot {
> /// disks for booting (e.g. software-raid), you need to specify all of
> /// them here.
> ///
> - /// Overrides the deprecated 'legacy=[acdn]*' value when given.
> + /// Overrides the deprecated `legacy=[acdn]*` value when given.
> #[serde(default, skip_serializing_if = "Option::is_none")]
> pub order: Option<String>,
> }
ping
_______________________________________________
pdm-devel mailing list
pdm-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel