From patchwork Thu Jan 9 12:29:13 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= X-Patchwork-Id: 11325561 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id D1F12139A for ; Thu, 9 Jan 2020 12:29:54 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 9DAF82072A for ; Thu, 9 Jan 2020 12:29:54 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="JRjbVp/P" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 9DAF82072A Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Received: from localhost ([::1]:59476 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ipWwj-0006mN-OH for patchwork-qemu-devel@patchwork.kernel.org; Thu, 09 Jan 2020 07:29:53 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:36751) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ipWwF-0006LZ-Sj for qemu-devel@nongnu.org; Thu, 09 Jan 2020 07:29:25 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ipWwD-00082Z-UJ for qemu-devel@nongnu.org; Thu, 09 Jan 2020 07:29:23 -0500 Received: from us-smtp-2.mimecast.com ([207.211.31.81]:57192 helo=us-smtp-delivery-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1ipWwC-0007z6-Iv for qemu-devel@nongnu.org; Thu, 09 Jan 2020 07:29:21 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1578572958; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=plL6EIFk4cKRv88DdZI+t0KHOUb2itd0ikjWZftQJVE=; b=JRjbVp/PyamXhLNLoVeORzu2mZqK2SMkPkQZi1NTemEJfvQNZ/pNedomeW8IqYyMTZ+S5l RMHWC+IPqLA23aLvtGsF5O3S2TSk6LH+iG8o01MranspTmsRChCIHTxYLyl3uuJ13Kmx+e Abgf7QT1jdMCH10FPV2aGb6E+CtHxcQ= 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-189-7MavtPrhMoa266pPA7K-Nw-1; Thu, 09 Jan 2020 07:29:17 -0500 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 257BE8024D9 for ; Thu, 9 Jan 2020 12:29:16 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-65.ams2.redhat.com [10.36.112.65]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3E3C428980; Thu, 9 Jan 2020 12:29:14 +0000 (UTC) From: =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= To: qemu-devel@nongnu.org Subject: [PATCH] docs: stop documenting the e1000 NIC model as the default Date: Thu, 9 Jan 2020 12:29:13 +0000 Message-Id: <20200109122913.3413914-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-MC-Unique: 7MavtPrhMoa266pPA7K-Nw-1 X-Mimecast-Spam-Score: 0 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 207.211.31.81 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" The default NIC model for QEMU varies per machine type, and is liable to change across machine type versions. Documenting e1000 NIC as the default for PC/i386 is thus misleading to users at best. In particular the PC q35 machine type switched to use e1000e, but only in machine type versions after 2.11. Rather than try to explain which NIC model is used for each machine type version, remove mention of e1000 as the default, and steer users towards always specifying their desired model. Signed-off-by: Daniel P. Berrangé Reviewed-by: Thomas Huth --- qemu-options.hx | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index e9d6231438..ca57145126 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -2344,8 +2344,7 @@ Use @option{model=help} to list the available device types. The hardware MAC address can be set with @option{mac=@var{macaddr}}. The following two example do exactly the same, to show how @option{-nic} can -be used to shorten the command line length (note that the e1000 is the default -on i386, so the @option{model=e1000} parameter could even be omitted here, too): +be used to shorten the command line length: @example @value{qemu_system} -netdev user,id=n1,ipv6=off -device e1000,netdev=n1,mac=52:54:98:76:54:32 @value{qemu_system} -nic user,ipv6=off,model=e1000,mac=52:54:98:76:54:32 @@ -2759,9 +2758,12 @@ netdev with ID @var{nd} by using the @option{netdev=@var{nd}} option. Legacy option to configure or create an on-board (or machine default) Network Interface Card(NIC) and connect it either to the emulated hub with ID 0 (i.e. the default hub), or to the netdev @var{nd}. -The NIC is an e1000 by default on the PC target. Optionally, the MAC address -can be changed to @var{mac}, the device address set to @var{addr} (PCI cards -only), and a @var{name} can be assigned for use in monitor commands. +If @var{model} is omitted, then the default NIC model associated with +the machine type is used. Note that the default NIC model may change in +future QEMU releases, so it is highly recommended to always specify a model. +Optionally, the MAC address can be changed to @var{mac}, the device +address set to @var{addr} (PCI cards only), and a @var{name} can be +assigned for use in monitor commands. Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors that the card should have; this option currently only affects virtio cards; set @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single