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 7502B1FF173 for ; Mon, 11 Nov 2024 14:56:04 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 33A05CB2E; Mon, 11 Nov 2024 14:55:16 +0100 (CET) From: Fiona Ebner To: pve-devel@lists.proxmox.com Date: Mon, 11 Nov 2024 14:54:28 +0100 Message-Id: <20241111135436.82773-2-f.ebner@proxmox.com> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241111135436.82773-1-f.ebner@proxmox.com> References: <20241111135436.82773-1-f.ebner@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL -0.057 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 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: [pve-devel] [PATCH v4 docs 1/9] configuration files: add general section 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" Explain the mixed casing styles for (sub-)properties in configuration files and plans regarding the future. Signed-off-by: Fiona Ebner --- New in v4. configuration-files.adoc | 28 ++++++++++++++++++++++++++++ pve-admin-guide.adoc | 2 +- 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 configuration-files.adoc diff --git a/configuration-files.adoc b/configuration-files.adoc new file mode 100644 index 0000000..aeb6cf4 --- /dev/null +++ b/configuration-files.adoc @@ -0,0 +1,28 @@ +[[configuration_files]] +General +======= + +Most configuration files in {pve} reside on the +xref:chapter_pmxcfs[shared cluster file system] mounted at `/etc/pve`. There are +exceptions, like the node-specific configuration file for backups in +`/etc/vzdump.conf`. + +Usually, the properties in a configuration file are derived from the JSON Schema +that is also used for the associated API endpoints. + +[[configuration_files_casing]] +Casing of Property Names +------------------------ + +Historically, longer properties (and sub-properties) often used `snake_case`, or +were written as one word. This can likely be attributed to the {pve} stack being +developed mostly in the programming language Perl, where access to properties +using `kebab-case` requires additional quotes, as well as less style enforcement +during early development, so different developers used different conventions. + +For new properties, `kebab-case` is the preferred way and it is planned to +introduce aliases for existing `snake_case` properties, and in the long term, +switch over to `kebab-case` for the API, CLI and in-use configuration files +while maintaining backwards-compatibility when restoring a configuration. + +include::datacenter.cfg.adoc[] diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc index 2a37df4..9a0ec85 100644 --- a/pve-admin-guide.adoc +++ b/pve-admin-guide.adoc @@ -308,7 +308,7 @@ Configuration Files ------------------- :leveloffset: 2 -include::datacenter.cfg.adoc[] +include::configuration-files.adoc[] :leveloffset: 0 -- 2.39.5 _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel