From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 28E7B1FF187 for ; Fri, 19 Dec 2025 20:45:58 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id DF85214960; Fri, 19 Dec 2025 20:45:51 +0100 (CET) From: "Max R. Carrara" To: pve-devel@lists.proxmox.com Date: Fri, 19 Dec 2025 20:44:53 +0100 Message-ID: <20251219194511.840583-19-m.carrara@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20251219194511.840583-1-m.carrara@proxmox.com> References: <20251219194511.840583-1-m.carrara@proxmox.com> MIME-Version: 1.0 X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1766173536008 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.083 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_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pve-devel] [PATCH pve-common v1 18/23] sectionconfig: reword docs regarding property usage in isolated mode X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox VE development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" In the MODES section, clarify that declaring a plugin's own properties in `options()` is not necessary in isolated mode for visibility's sake. The phrase "automatically added to its schema" might otherwise not be completely clear to lesser experienced users. Also reword a similar paragraph in the docstring for the `properties()` method, making it a little less wordy overall. Additionally, that paragraph mentions that a local property may be marked as required in `options()`, which is incorrect, so get rid of that passage of text too. Signed-off-by: Max R. Carrara --- src/PVE/SectionConfig.pm | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/PVE/SectionConfig.pm b/src/PVE/SectionConfig.pm index 6504399..6ad8772 100644 --- a/src/PVE/SectionConfig.pm +++ b/src/PVE/SectionConfig.pm @@ -90,7 +90,9 @@ return value of the Coptions() >>> method when it's eit C or stems from the global list of properties. All I defined properties of a child plugin are automatically added to -its schema. +its schema. This means that is is not necessary to declare the usage of a +plugin's own properties in its own Coptions() >>> +method, unless one wants to declare it as C. =cut @@ -352,9 +354,8 @@ wishes to use them. In I>, the locally defined properties (those registered by overriding Cproperties() >>>) are automatically -added to the plugin's schema and made C by default. Should this not be -desired, a property may still be explicitly defined, in order to make it required -or C instead. +added to the plugin's schema and made C by default. However, marking +the property as C must still be done via Coptions() >>>. =cut -- 2.47.3 _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel