From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <m.heiserer@proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits))
 (No client certificate requested)
 by lists.proxmox.com (Postfix) with ESMTPS id 0D45D632C8
 for <pve-devel@lists.proxmox.com>; Mon, 14 Feb 2022 15:02:06 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
 by firstgate.proxmox.com (Proxmox) with ESMTP id D8B402337C
 for <pve-devel@lists.proxmox.com>; Mon, 14 Feb 2022 15:02:05 +0100 (CET)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
 [94.136.29.106])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits))
 (No client certificate requested)
 by firstgate.proxmox.com (Proxmox) with ESMTPS id 9CDD823315
 for <pve-devel@lists.proxmox.com>; Mon, 14 Feb 2022 15:02:03 +0100 (CET)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
 by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 6892941C21
 for <pve-devel@lists.proxmox.com>; Mon, 14 Feb 2022 15:02:03 +0100 (CET)
From: Matthias Heiserer <m.heiserer@proxmox.com>
To: pve-devel@lists.proxmox.com
Date: Mon, 14 Feb 2022 15:01:37 +0100
Message-Id: <20220214140144.961041-1-m.heiserer@proxmox.com>
X-Mailer: git-send-email 2.30.2
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results:  0
 AWL 0.003 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 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
 T_SCC_BODY_TEXT_LINE    -0.01 -
Subject: [pve-devel] [RFC manager 0/5] GUI: Hardware comments
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Mon, 14 Feb 2022 14:02:06 -0000

This series is a first attempt to fix 2672 by implementing editable comments
that are displayed in the GUI and stored in the qemu config file. 

It works, but there are several questions:

How should comments be displayed? (GUI)
    I added a third column. IMO, this looks cleaner than the alternative of
    appending the comment to the corresponding config values. However, it 
    requires more space and some special logic.
    
What to do when there is not enough space? (GUI)
    Currently, this case is not handled. A possible solution would be to
    wrap overflowing lines, but I'm not sure what opinions are on that.
    
Should comments of ineditable fields (EFI Disk) be editable? (GUI)
    I suppose yes, but currently they are not.

Currently missing are:
    GUI: Comments in the wizard, i.e. when creating a VM, no comment can be set.
    Detaching disks voids their comment. Probably shouldn't happen, but seems
        a tad complicated.
    The GUI assumes comments (except memory, socket, bios,  machine, scsihw)
        to be URIencoded. This could be verified server-side.

Generally, I tried to keep the code consistent, but didnt always succeed, partly
because of the variations in the original code.


Matthias Heiserer (5):
  GUI: Parser: add comment support
  GUI: Utils: add comment renderer and field provider
  GUI: QEMU Hardware: add comment column
  GUI: QEMU Hardware: multikey support for comments
  GUI: QEMU Hardware: add comment fields to rows

 www/manager6/Parser.js             | 22 +++++++++++++++
 www/manager6/Utils.js              | 39 +++++++++++++++++++++++++++
 www/manager6/qemu/AudioEdit.js     |  3 ++-
 www/manager6/qemu/CDEdit.js        |  7 ++---
 www/manager6/qemu/CIDriveEdit.js   |  2 ++
 www/manager6/qemu/DisplayEdit.js   |  2 +-
 www/manager6/qemu/HDEdit.js        |  4 +++
 www/manager6/qemu/HDEfi.js         |  3 +++
 www/manager6/qemu/HDTPM.js         |  2 ++
 www/manager6/qemu/HardwareView.js  | 43 +++++++++++++++++++++++++++++-
 www/manager6/qemu/MachineEdit.js   | 24 ++++++++++-------
 www/manager6/qemu/MemoryEdit.js    |  3 +++
 www/manager6/qemu/NetworkEdit.js   |  7 +++--
 www/manager6/qemu/PCIEdit.js       |  1 +
 www/manager6/qemu/ProcessorEdit.js |  1 +
 www/manager6/qemu/QemuBiosEdit.js  |  1 +
 www/manager6/qemu/RNGEdit.js       |  1 +
 www/manager6/qemu/ScsiHwEdit.js    | 15 ++++++-----
 www/manager6/qemu/SerialEdit.js    |  6 ++---
 www/manager6/qemu/USBEdit.js       | 13 ++++++++-
 20 files changed, 171 insertions(+), 28 deletions(-)

-- 
2.30.2