From nobody Sun May 19 02:38:26 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1684848707; cv=none; d=zohomail.com; s=zohoarc; b=M1TRhImosYXBuewWr0ps67/zLcdPnDbiQS3fN2BG9Uhzst1Le0Oyr+9U+jlKYCqk0I725ZQtg5CAUpoA39lvT/30HYlh8vK1lVoLEBikkgLAGbK+HT9bXteRSpmCIBHDJOrxwDMwQWBGblxAwlQtnTQsoC/HS5tFDLS0nm+VnKM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1684848707; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=ALH8ygfQExhI64PQIFKaxa6QiTxPIbjn4rjrnsnGxtE=; b=GYmp2ZpDIG3Dzh3C/BaBME6I94GrC15Ye4yu9LX8EjqnLvZKSodglobyeT/CAlAu06IpV/r9Kvk3HWhNg4ovdMatMpLvAuMqACyrlZA/HBD7UEoDEkXCXzDpN6w39MFYoV2itibik+ur84cBPDhx0WvmBo3ORqnDf+1qyfjRG1k= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 168484870714541.18848032531537; Tue, 23 May 2023 06:31:47 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1q1S6v-0004fW-7C; Tue, 23 May 2023 09:31:33 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1q1S6s-0004XB-E2 for qemu-devel@nongnu.org; Tue, 23 May 2023 09:31:30 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1q1S6q-00061H-5i for qemu-devel@nongnu.org; Tue, 23 May 2023 09:31:29 -0400 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-620--s9d3AC7OxuqYhjmSswZfw-1; Tue, 23 May 2023 09:31:21 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 3B0CF101B047; Tue, 23 May 2023 13:31:21 +0000 (UTC) Received: from pinwheel.wattfactory.local (unknown [10.39.194.85]) by smtp.corp.redhat.com (Postfix) with ESMTP id ECB2740D1B60; Tue, 23 May 2023 13:31:18 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1684848684; 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=ALH8ygfQExhI64PQIFKaxa6QiTxPIbjn4rjrnsnGxtE=; b=S4HucrZwBo65PyGaI46I6kG6pkVPCY78tR74DToCkaCeJ3vVi9WqfuRigRZi1i+gRDwomy Mo7RuVEcvr3iHldoVUfLG2FAEtMdRJipoiLmMJiv7B8tBxfhh9Qm/QQIbLGfqXIpB+wJc2 KDC7ogOAsszSZPGMhO1Jw1RO9vWxG6A= X-MC-Unique: -s9d3AC7OxuqYhjmSswZfw-1 From: Kashyap Chamarthy To: qemu-devel@nongnu.org Cc: alex.bennee@linaro.org, Paolo Bonzini , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Kashyap Chamarthy Subject: [PATCH v2] docs: build-system: rename "default-configs" to "configs" Date: Tue, 23 May 2023 15:31:17 +0200 Message-Id: <20230523133117.2278587-1-kchamart@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.2 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=kchamart@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1684848709399100003 Content-Type: text/plain; charset="utf-8" Commit 812b31d3f9 (configs: rename default-configs to configs and reorganise, 2021-07-07) did the rename. Reflect that update also in the documentation. Signed-off-by: Kashyap Chamarthy --- docs/devel/build-system.rst | 12 +++++------ docs/devel/kconfig.rst | 40 ++++++++++++++++++++----------------- 2 files changed, 28 insertions(+), 24 deletions(-) diff --git a/docs/devel/build-system.rst b/docs/devel/build-system.rst index 1894721743..20ebcc9ac6 100644 --- a/docs/devel/build-system.rst +++ b/docs/devel/build-system.rst @@ -193,7 +193,7 @@ Target-dependent emulator sourcesets: Each emulator also includes sources for files in the ``hw/`` and ``targe= t/`` subdirectories. The subdirectory used for each emulator comes from the target's definition of ``TARGET_BASE_ARCH`` or (if missing) - ``TARGET_ARCH``, as found in ``default-configs/targets/*.mak``. + ``TARGET_ARCH``, as found in ``configs/targets/*.mak``. =20 Each subdirectory in ``hw/`` adds one sourceset to the ``hw_arch`` dicti= onary, for example:: @@ -250,8 +250,8 @@ Utility sourcesets: The following files concur in the definition of which files are linked into each emulator: =20 -``default-configs/devices/*.mak`` - The files under ``default-configs/devices/`` control the boards and devi= ces +``configs/devices/*.mak`` + The files under ``configs/devices/`` control the boards and devices that are built into each QEMU system emulation targets. They merely cont= ain a list of config variable definitions such as:: =20 @@ -260,11 +260,11 @@ into each emulator: CONFIG_XLNX_VERSAL=3Dy =20 ``*/Kconfig`` - These files are processed together with ``default-configs/devices/*.mak`= ` and + These files are processed together with ``configs/devices/*.mak`` and describe the dependencies between various features, subsystems and device models. They are described in :ref:`kconfig` =20 -``default-configs/targets/*.mak`` +``configs/targets/*.mak`` These files mostly define symbols that appear in the ``*-config-target.h= `` file for each emulator [#cfgtarget]_. However, the ``TARGET_ARCH`` and ``TARGET_BASE_ARCH`` will also be used to select the ``hw/`` and @@ -457,7 +457,7 @@ Built by Meson: TARGET-NAME is again the name of a system or userspace emulator. The config-devices.mak file is automatically generated by make using the scripts/make_device_config.sh program, feeding it the - default-configs/$TARGET-NAME file as input. + configs/$TARGET-NAME file as input. =20 ``config-host.h``, ``$TARGET_NAME-config-target.h``, ``$TARGET_NAME-config= -devices.h`` These files are used by source code to determine what features are diff --git a/docs/devel/kconfig.rst b/docs/devel/kconfig.rst index e3a544e463..73118e5106 100644 --- a/docs/devel/kconfig.rst +++ b/docs/devel/kconfig.rst @@ -38,11 +38,11 @@ originated in the Linux kernel, though it was heavily s= implified and the handling of dependencies is stricter in QEMU. =20 Unlike Linux, there is no user interface to edit the configuration, which -is instead specified in per-target files under the ``default-configs/`` +is instead specified in per-target files under the ``configs/target/`` directory of the QEMU source tree. This is because, unlike Linux, -configuration and dependencies can be treated as a black box when building -QEMU; the default configuration that QEMU ships with should be okay in -almost all cases. +configuration and dependencies can be treated as a black box when +building QEMU; the default configuration that QEMU ships with should be +okay in almost all cases. =20 The Kconfig language -------------------- @@ -103,11 +103,12 @@ directives can be included: **default value**: ``default [if ]`` =20 Default values are assigned to the config symbol if no other value was - set by the user via ``default-configs/*.mak`` files, and only if - ``select`` or ``depends on`` directives do not force the value to true - or false respectively. ```` can be ``y`` or ``n``; it cannot - be an arbitrary Boolean expression. However, a condition for applying - the default value can be added with ``if``. + set by the user via + ``configs/devices/TARGETNAME-softmmu/*.mak`` files, and only + if ``select`` or ``depends on`` directives do not force the value to + true or false respectively. ```` can be ``y`` or ``n``; it + cannot be an arbitrary Boolean expression. However, a condition for + applying the default value can be added with ``if``. =20 A configuration element can have any number of default values (usually, if more than one default is present, they will have different @@ -119,8 +120,8 @@ directives can be included: This is similar to ``select`` as it applies a lower limit of ``y`` to another symbol. However, the lower limit is only a default and the "implied" symbol's value may still be set to ``n`` from a - ``default-configs/*.mak`` files. The following two examples are - equivalent:: + ``configs/devices/TARGETNAME-softmmu/*.mak`` files. The following + two examples are equivalent:: =20 config FOO bool @@ -146,8 +147,9 @@ declares its dependencies in different ways: bool =20 Subsystems always default to false (they have no ``default`` directive) - and are never visible in ``default-configs/*.mak`` files. It's - up to other symbols to ``select`` whatever subsystems they require. + and are never visible in ``configs/devices/TARGETNAME-softmmu/*.mak`` + files. It's up to other symbols to ``select`` whatever subsystems + they require. =20 They sometimes have ``select`` directives to bring in other required subsystems or buses. For example, ``AUX`` (the DisplayPort auxiliary @@ -229,7 +231,8 @@ declares its dependencies in different ways: cannot be started at all without it. It should be listed under ``imply`` if (depending on the QEMU command line) the board may or may not be started without it. Boards also default to false; they are - enabled by the ``default-configs/*.mak`` for the target they apply to. + enabled by the ``configs/targets/TARGETNAME-softmmu/*.mak`` for the + target they apply to. =20 **internal elements** =20 @@ -241,18 +244,19 @@ declares its dependencies in different ways: =20 Internal elements group code that is useful in several boards or devices. They are usually enabled with ``select`` and in turn select - other elements; they are never visible in ``default-configs/*.mak`` - files, and often not even in the Makefile. + other elements; they are never visible in + ``configs/devices/TARGETNAME-softmmu/*.mak`` files, and often not even + in the Makefile. =20 Writing and modifying default configurations -------------------------------------------- =20 In addition to the Kconfig files under hw/, each target also includes -a file called ``default-configs/TARGETNAME-softmmu.mak``. These files +a file called ``configs/devices/TARGETNAME-softmmu.mak``. These files initialize some Kconfig variables to non-default values and provide the starting point to turn on devices and subsystems. =20 -A file in ``default-configs/`` looks like the following example:: +A file in ``configs/devices/`` looks like the following example:: =20 # Default configuration for alpha-softmmu =20 --=20 2.40.1