From nobody Sat Nov 15 12:46:57 2025 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=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1752144537; cv=none; d=zohomail.com; s=zohoarc; b=EacCM+baE4Ywizk7gu0mZk6I0oqBfL4CfZxAWLgnOsmriIIyk98UIvVUBsZREToYiRGuDZc8w1iALeKKBUazPgDAcrRYRoORKnx+fCB4j9k102/o8fyZbuPYp53OnLrHAbMxThPGKLYzlSNF3zfjD9FZ7qvu/zb0OEzlTpC97/I= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1752144537; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=/kn+Nlme/iAkqffgZvptFY3jhjfV+Qi2QuRGeFFxrUg=; b=l06k0BkOrrK3D6elfmBY03EbEXjLoo32ruuQB6Lb9hAi/R67Ylu+XbMGmHtYPsOpi5+KYIXwhnl1fMV/jVMu2M/HYRA9dGXRGj5h7HFZbap9jEEghi0U25GKXa+Qg0MphVEujjQlNI+PBIYKnY0mctLBtBUf9XRpEMzNQ2t7ON4= 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 1752144537021553.1690214652364; Thu, 10 Jul 2025 03:48:57 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1uZon2-00021V-Jc; Thu, 10 Jul 2025 06:46:08 -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 1uZomh-0001rC-DN for qemu-devel@nongnu.org; Thu, 10 Jul 2025 06:45:51 -0400 Received: from mail-wm1-x332.google.com ([2a00:1450:4864:20::332]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1uZomZ-00078C-Ud for qemu-devel@nongnu.org; Thu, 10 Jul 2025 06:45:45 -0400 Received: by mail-wm1-x332.google.com with SMTP id 5b1f17b1804b1-45348bff79fso8982555e9.2 for ; Thu, 10 Jul 2025 03:45:39 -0700 (PDT) Received: from draig.lan ([185.126.160.19]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-454d511bd6dsm55989185e9.38.2025.07.10.03.45.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 10 Jul 2025 03:45:36 -0700 (PDT) Received: from draig.lan (localhost [IPv6:::1]) by draig.lan (Postfix) with ESMTP id C71665F8CC; Thu, 10 Jul 2025 11:45:31 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1752144338; x=1752749138; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=/kn+Nlme/iAkqffgZvptFY3jhjfV+Qi2QuRGeFFxrUg=; b=LJThjoHtyAsPT9vWMffJu8fRNU/Pq7r5LQnl25T451xatxofd13/CD3eE1pEhV6Jxw hVhsvfZZfrEYH3FgZWJpRBQGskfES20nzdZtWZztk4l0q7DXB/YQ8c9WVVQA/R0PjDa6 ErMRlc/wYCz3x98UWfHCffD1bIFxcmK/1z6Fv4aGLmVnfZAQGG2G/QG3rqrQOgxnCuWK UcDUZPHAwDfqZLsFvhBDAv7LqewsOM48KKfQdry9lRHP5gvUgvEXoqJmMjkDYWpgL4CF uWexl2vO3CbM4OEQP16DDk6PL+snG52kjVNryU8k37kplRLacvFgiDHxleAawGWerEsM 9RJQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1752144338; x=1752749138; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=/kn+Nlme/iAkqffgZvptFY3jhjfV+Qi2QuRGeFFxrUg=; b=l2Y2fT4Sth5xIDiwPm/1mfgFz40AYB6zgOSqSn+wb7m6HWIrdWJ384D/rRU5PN+f5u GdI7FD8pAaKSCAK1UGHd9d/7DuJVoKiL53ofiqz5vZYJ3BdrUAkEXvdUnsgrvg9yhmar zIS7EtlSnghkW+u01JXxEglkiiI/lAF2ErFhjg+dDWeXdhHhPV36ElXbubijYXM3PwPt 2Sk0+NEvsD07Zd71jHsrxiyEmIfBWysUSIlY1obP3Pu90iya3/cuN3ITIAsQr3wbKxdi TlSyalZ8r2NiFpZXctzQXvrgrguGnoKBIa4H+YgCEogEo3YU2dn1dR5GMyH4Iom1Euyi LoJA== X-Gm-Message-State: AOJu0YxJkT8jurUO9lvl5PaZcCtsjTmeGM5mWU/GhC4vgOICy8dpUmBF j/+K1rkQB58tX9sHTFdckTH0wcWvwmVHwQ+uHB6vk1eQPdKNskE2maLqfEijLeJRaZE= X-Gm-Gg: ASbGncuBIUHC/PG2hig00lDUU9IG8cKK6+J3cM4Ol8r/9b5ISNkK8NskWyU+6RXiU9Z 2jVT3bXW0sNNWq8h/4uM9lFFLG10VvqXjiiSmpzUXLaHHWJdUtsetQkYPvHmi6PzZJySnHJzhkA U3+vcM9Fd9npnCZjZWcIxzuAhMPtroL1fv9wEotfYzFe2qdhzl8fVMBT04ZLnt3y38oKS9aDapj 3bUEl9mTbuSkLbPU8DYi+yEEgvH4z6MuhJuDeC5WylZ6eApylwKnhuh/ZgmCSOC7MNvNkfvd5Uf naargNiJScfuoUDpIYnrm1dnG4qBah3lVQqj0Jw67L1uQgk6D5OknM61NSfu+jw= X-Google-Smtp-Source: AGHT+IHTgRA7pgf1Mh+2rw9zldooRzB6GIP2uUxDs22K2ZKN36igrTMdd6T74rRfvOJj+DKWSzGFZA== X-Received: by 2002:a05:600c:a00c:b0:43c:f44c:72a6 with SMTP id 5b1f17b1804b1-454dd1f3edbmr19383905e9.2.1752144337535; Thu, 10 Jul 2025 03:45:37 -0700 (PDT) From: =?UTF-8?q?Alex=20Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Mahmoud Mandour , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Alexandre Iooss , =?UTF-8?q?Alex=20Benn=C3=A9e?= , Thomas Huth , Richard Henderson , Jason Wang , Riku Voipio , Laurent Vivier , Pierrick Bouvier , Manos Pitsidianakis Subject: [PATCH 6/7] docs: use :kbd: role in sphinx docs Date: Thu, 10 Jul 2025 11:45:29 +0100 Message-ID: <20250710104531.3099313-7-alex.bennee@linaro.org> X-Mailer: git-send-email 2.47.2 In-Reply-To: <20250710104531.3099313-1-alex.bennee@linaro.org> References: <20250710104531.3099313-1-alex.bennee@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable 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=2a00:1450:4864:20::332; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x332.google.com X-Spam_score_int: 12 X-Spam_score: 1.2 X-Spam_bar: + X-Spam_report: (1.2 / 5.0 requ) BAYES_00=-1.9, 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_SBL_CSS=3.335, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no 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 @linaro.org) X-ZM-MESSAGEID: 1752144538494116600 From: Manos Pitsidianakis Sphinx supports the :kbd: role for notating keyboard input. They get formatted as HTML elements in the readthedocs theme we currently use for Sphinx. Besides the better visual formatting, it also helps with accessibility as screen readers can announce the semantics of the element to the user. Signed-off-by: Manos Pitsidianakis Message-ID: <20250709-docs_rst_improvements-v2-1-cb5096ad0022@linaro.org> Signed-off-by: Alex Benn=C3=A9e --- docs/devel/testing/main.rst | 4 +-- docs/system/images.rst | 2 +- docs/system/keys.rst.inc | 49 +++++++++++++++++---------------- docs/system/linuxboot.rst | 2 +- docs/system/mux-chardev.rst.inc | 38 ++++++++++++++----------- 5 files changed, 51 insertions(+), 44 deletions(-) diff --git a/docs/devel/testing/main.rst b/docs/devel/testing/main.rst index 6b18ed875c..2b5cb0c148 100644 --- a/docs/devel/testing/main.rst +++ b/docs/devel/testing/main.rst @@ -604,9 +604,9 @@ below steps to debug it: 2. Add "V=3D1" to the command line, try again, to see the verbose output. 3. Further add "DEBUG=3D1" to the command line. This will pause in a shell= prompt in the container right before testing starts. You could either manually - build QEMU and run tests from there, or press Ctrl-D to let the Docker + build QEMU and run tests from there, or press :kbd:`Ctrl+d` to let the = Docker testing continue. -4. If you press Ctrl-D, the same building and testing procedure will begin= , and +4. If you press :kbd:`Ctrl+d`, the same building and testing procedure wil= l begin, and will hopefully run into the error again. After that, you will be droppe= d to the prompt for debug. =20 diff --git a/docs/system/images.rst b/docs/system/images.rst index a5551173c9..43706969fd 100644 --- a/docs/system/images.rst +++ b/docs/system/images.rst @@ -30,7 +30,7 @@ Snapshot mode If you use the option ``-snapshot``, all disk images are considered as read only. When sectors in written, they are written in a temporary file created in ``/tmp``. You can however force the write back to the raw -disk images by using the ``commit`` monitor command (or C-a s in the +disk images by using the ``commit`` monitor command (or :kbd:`Ctrl+a s` in= the serial console). =20 .. _vm_005fsnapshots: diff --git a/docs/system/keys.rst.inc b/docs/system/keys.rst.inc index 59966a3fe7..c28ae1a227 100644 --- a/docs/system/keys.rst.inc +++ b/docs/system/keys.rst.inc @@ -1,36 +1,37 @@ During the graphical emulation, you can use special key combinations from -the following table to change modes. By default the modifier is Ctrl-Alt +the following table to change modes. By default the modifier is :kbd:`Ctrl= +Alt` (used in the table below) which can be changed with ``-display`` suboption ``mod=3D`` where appropriate. For example, ``-display sdl, -grab-mod=3Dlshift-lctrl-lalt`` changes the modifier key to Ctrl-Alt-Shift, -while ``-display sdl,grab-mod=3Drctrl`` changes it to the right Ctrl key. +grab-mod=3Dlshift-lctrl-lalt`` changes the modifier key to :kbd:`Ctrl+Alt+= Shift`, +while ``-display sdl,grab-mod=3Drctrl`` changes it to the right :kbd:`Ctrl= ` key. =20 -Ctrl-Alt-f - Toggle full screen +.. list-table:: Multiplexer Keys + :widths: 10 90 + :header-rows: 1 =20 -Ctrl-Alt-+ - Enlarge the screen + * - Key Sequence + - Action =20 -Ctrl-Alt\-- - Shrink the screen + * - :kbd:`Ctrl+Alt+f` + - Toggle full screen =20 -Ctrl-Alt-u - Restore the screen's un-scaled dimensions + * - :kbd:`Ctrl+Alt++` + - Enlarge the screen =20 -Ctrl-Alt-n - Switch to virtual console 'n'. Standard console mappings are: + * - :kbd:`Ctrl+Alt+-` + - Shrink the screen =20 - *1* - Target system display + * - :kbd:`Ctrl+Alt+u` + - Restore the screen's un-scaled dimensions =20 - *2* - Monitor + * - :kbd:`Ctrl+Alt+n` + - Switch to virtual console 'n'. Standard console mappings are: =20 - *3* - Serial port + - *1*: Target system display + - *2*: Monitor + - *3*: Serial port + * - :kbd:`Ctrl+Alt+g` + - Toggle mouse and keyboard grab. =20 -Ctrl-Alt-g - Toggle mouse and keyboard grab. - -In the virtual consoles, you can use Ctrl-Up, Ctrl-Down, Ctrl-PageUp and -Ctrl-PageDown to move in the back log. +In the virtual consoles, you can use :kbd:`Ctrl+Up`, :kbd:`Ctrl+Down`, :kb= d:`Ctrl+PageUp` and +:kbd:`Ctrl+PageDown` to move in the back log. diff --git a/docs/system/linuxboot.rst b/docs/system/linuxboot.rst index 2328b4a73d..f7573ab80a 100644 --- a/docs/system/linuxboot.rst +++ b/docs/system/linuxboot.rst @@ -26,5 +26,5 @@ virtual serial port and the QEMU monitor to the console w= ith the |qemu_system| -kernel bzImage -drive file=3Drootdisk.img,format=3Draw \ -append "root=3D/dev/sda console=3DttyS0" -nographic =20 -Use Ctrl-a c to switch between the serial console and the monitor (see +Use :kbd:`Ctrl+a c` to switch between the serial console and the monitor (= see :ref:`GUI_keys`). diff --git a/docs/system/mux-chardev.rst.inc b/docs/system/mux-chardev.rst.= inc index 84ea12cbf5..c87ba31362 100644 --- a/docs/system/mux-chardev.rst.inc +++ b/docs/system/mux-chardev.rst.inc @@ -1,27 +1,33 @@ During emulation, if you are using a character backend multiplexer (which is the default if you are using ``-nographic``) then several commands are available via an escape sequence. These key sequences all -start with an escape character, which is Ctrl-a by default, but can be +start with an escape character, which is :kbd:`Ctrl+a` by default, but can= be changed with ``-echr``. The list below assumes you're using the default. =20 -Ctrl-a h - Print this help +.. list-table:: Multiplexer Keys + :widths: 20 80 + :header-rows: 1 =20 -Ctrl-a x - Exit emulator + * - Key Sequence + - Action =20 -Ctrl-a s - Save disk data back to file (if -snapshot) + * - :kbd:`Ctrl+a h` + - Print this help =20 -Ctrl-a t - Toggle console timestamps + * - :kbd:`Ctrl+a x` + - Exit emulator =20 -Ctrl-a b - Send break (magic sysrq in Linux) + * - :kbd:`Ctrl+a s` + - Save disk data back to file (if -snapshot) =20 -Ctrl-a c - Rotate between the frontends connected to the multiplexer (usually - this switches between the monitor and the console) + * - :kbd:`Ctrl+a t` + - Toggle console timestamps =20 -Ctrl-a Ctrl-a - Send the escape character to the frontend + * - :kbd:`Ctrl+a b` + - Send break (magic sysrq in Linux) + + * - :kbd:`Ctrl+a c` + - Rotate between the frontends connected to the multiplexer (usually t= his switches between the monitor and the console) + + * - :kbd:`Ctrl+a Ctrl+a` + - Send the escape character to the frontend --=20 2.47.2