From nobody Mon Nov 25 12:23:30 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) client-ip=63.128.21.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1602754501; cv=none; d=zohomail.com; s=zohoarc; b=jAvus71UwiV2ld9HhyrYROyYYHTU0jeVJSFQStur/6VARTjy/dsXXukmP3w9t40EpzDkRs3mh/4dO1IWQ/PkJIn9HYOwaGvYPBmrWiNO/mPikbN/YnlzKytzF7/oJluQP3xdszaB2k0mnmV0Pje3g2qO+sp0SkMwIytvX49Ao9s= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1602754501; h=Content-Type:Content-Transfer-Encoding:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=L8JFHmDjILB/Pif59bhhUqsjHSEHRGDUmc7h+CVsAdc=; b=l4YB/nHji7yYFzBLHC6HczgbmfQ4KEIZmb5RFwUcxN1mqRMkGv8CdyS1L64Ubim9XEm8DkIXS++DzpHSDyjwpUJ4MDqi8fCUKHcsCdnxzolmTQcs2gyZDsOFgtt1n8k3lKN4h5ZtUbRVjh2OVPZrSpZ7mK3QUZlkFB1f1bSE1pU= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124]) by mx.zohomail.com with SMTPS id 1602754501666204.16337398053213; Thu, 15 Oct 2020 02:35:01 -0700 (PDT) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-596-KjpNs1UYOoS0TaBEge_b3g-1; Thu, 15 Oct 2020 05:34:58 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 35B0A593B1; Thu, 15 Oct 2020 09:34:51 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 243FD1002D42; Thu, 15 Oct 2020 09:34:50 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id BCFB85810F; Thu, 15 Oct 2020 09:34:46 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 09F9YjnR025303 for ; Thu, 15 Oct 2020 05:34:45 -0400 Received: by smtp.corp.redhat.com (Postfix) id B7DF95C22D; Thu, 15 Oct 2020 09:34:45 +0000 (UTC) Received: from localhost.localdomain (unknown [10.40.193.130]) by smtp.corp.redhat.com (Postfix) with ESMTP id 39A465C26A for ; Thu, 15 Oct 2020 09:34:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1602754500; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=L8JFHmDjILB/Pif59bhhUqsjHSEHRGDUmc7h+CVsAdc=; b=Wii/2pPbgrrH9r6kXaLx4Qt3DEQpAGtJn5DQY5Ax1TY1GTOLk+TJHXFt5CBNfi/MUSf+Nv zVoE+ekt/zSQrXYnQMvHRkG6BDKjqO9jq/b5G4xQ64DZmyqFEW3sYmB/orFXoffXsSQIYf JIkBe3fAWr+O+35j5azRusZqojYdAC4= X-MC-Unique: KjpNs1UYOoS0TaBEge_b3g-1 From: Michal Privoznik To: libvir-list@redhat.com Subject: [PATCH] docs: Document camelCase preference for XML elements and attributes Date: Thu, 15 Oct 2020 11:34:39 +0200 Message-Id: <2021e73d1cb9fb1859222f74470db24acddeed4d.1602754398.git.mprivozn@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Recently I've merged a patch that used hyphens in an attribute name. I fixed it later, but turned out we don't document our preference which is camelCase. Suggested-by: Erik Skultety Signed-off-by: Michal Privoznik --- I'm not sure this is the correct place to put this, suggestions welcome. docs/api_extension.html.in | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api_extension.html.in b/docs/api_extension.html.in index 6c64e83314..d7696056ac 100644 --- a/docs/api_extension.html.in +++ b/docs/api_extension.html.in @@ -110,6 +110,12 @@ src/libvirt_public.syms

=20 +

+ Please note that single word names for attributes and elements is + preferred. But if you have to use two ore more words please join the= m in + camelCase style. +

+

This task is in many ways the most important to get right, since once the API has been committed to the repository, it's libvirt's policy --=20 2.26.2