From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED,DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FORGED_FROMDOMAIN, FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A69CEC433E0 for ; Mon, 10 Aug 2020 18:36:34 +0000 (UTC) Received: from silver.osuosl.org (smtp3.osuosl.org [140.211.166.136]) (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 67B612083B for ; Mon, 10 Aug 2020 18:36:34 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="kDXYfS9f" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 67B612083B Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=linux-kernel-mentees-bounces@lists.linuxfoundation.org Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id 1430320416; Mon, 10 Aug 2020 18:36:34 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from silver.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id G7bxRF3dJTVx; Mon, 10 Aug 2020 18:36:32 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by silver.osuosl.org (Postfix) with ESMTP id EC3F020117; Mon, 10 Aug 2020 18:36:31 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id C8C32C013C; Mon, 10 Aug 2020 18:36:31 +0000 (UTC) Received: from whitealder.osuosl.org (smtp1.osuosl.org [140.211.166.138]) by lists.linuxfoundation.org (Postfix) with ESMTP id 017F3C004D for ; Mon, 10 Aug 2020 18:36:27 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id F15A986BC4 for ; Mon, 10 Aug 2020 18:36:26 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id P1pR84n3Bjoo for ; Mon, 10 Aug 2020 18:36:26 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail-pl1-f193.google.com (mail-pl1-f193.google.com [209.85.214.193]) by whitealder.osuosl.org (Postfix) with ESMTPS id 4713C86B3B for ; Mon, 10 Aug 2020 18:36:26 +0000 (UTC) Received: by mail-pl1-f193.google.com with SMTP id z20so5473910plo.6 for ; Mon, 10 Aug 2020 11:36:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=uJZO52EypTYHSYjNdKUzoiygtIPVe4OjaYIrjZLPnvQ=; b=kDXYfS9f9lvRcb9iK4bZ1ZpNzK/qn3jvpOE/SaSSzxMZ+juCDxvQwiaubEU/aAU2YQ KxHTGW94JEn8+r701lHRniWHK+XX5/AbQF2wJKi4f+RXyZNIOnnvPT4W4R6gegMUpNTS UcfvknKFKaC6ZCne4g/5RmN7KHecOzR6lCPh9O4E3lpKtHiX71lNhHQEKOsS9NdzasxC rNKSbkFRRgCep5+jo6zrbzs1HI32i1Go01OeYtKLee/BN8PXDQTMR6bpyb969BuBzwM2 8CSwKtfVMs6BU9jg49dFk+xYrs4YOErxBBDSzpcRL+VUvPWGHdPrV/ShVoVHWMn+A5WV hZzw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=uJZO52EypTYHSYjNdKUzoiygtIPVe4OjaYIrjZLPnvQ=; b=GxccRmaVmHoXRjjzRwmag3wBwPZzOr9ghpdLvmYiT1bFtQAf7UtVVvfgfekCUyHjXl QUy7QHN0oCGOud7wkNpXmuo+JDiLwhlPH4EuGN6VtkZfMna/LmlZnA1kiLjQygFEVcux SzW3n3YK5SwqsHCJkjWx8ocsw3MuW8Q0v3EQxYmCgNh064UsjiM7lfSuLXdxfH2UEKQk LHKfR+fprmkckE7GZbolK3ASFFQNlYmJwM17bfAh1JXWmV5j7KQSh+FsB2FgyIgoIk7d TIsX1zbpmf1lx/0/Relj7wzl5yiJLtz9fKkPIbdkwEEma5/WPIJ0uuB33Q1PO6tQbtrO dsxA== X-Gm-Message-State: AOAM531rOPUS5RU6PCuzZgMqZGxOsTE5IVffggog60Cc4/WRZGuI2E51 J7mr/zfEz4MfdxIDVC1WLXo= X-Google-Smtp-Source: ABdhPJwfI1hSagNB50QX5v1PgFswVEskV8SeB6Dj/aUaZ/VhyTOKzAEWK+6a9BWn3002NK9boxiC+Q== X-Received: by 2002:a17:90b:1093:: with SMTP id gj19mr617434pjb.149.1597084585696; Mon, 10 Aug 2020 11:36:25 -0700 (PDT) Received: from localhost.localdomain ([124.253.77.168]) by smtp.googlemail.com with ESMTPSA id c143sm4701092pfb.84.2020.08.10.11.36.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 10 Aug 2020 11:36:24 -0700 (PDT) From: Puranjay Mohan To: Jonathan Corbet Date: Tue, 11 Aug 2020 00:06:13 +0530 Message-Id: <20200810183613.25643-1-puranjay12@gmail.com> X-Mailer: git-send-email 2.27.0 MIME-Version: 1.0 Cc: linux-doc@vger.kernel.org, linux-kernel-mentees@lists.linuxfoundation.org, linux-kernel@vger.kernel.org, Puranjay Mohan Subject: [Linux-kernel-mentees] [PATCH] Dev-tools: Documentation: Replace deprecated :c:func: Usage X-BeenThere: linux-kernel-mentees@lists.linuxfoundation.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: linux-kernel-mentees-bounces@lists.linuxfoundation.org Sender: "Linux-kernel-mentees" Replace :c:func: with func() as the previous usage is deprecated. Signed-off-by: Puranjay Mohan --- Documentation/dev-tools/kgdb.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/dev-tools/kgdb.rst b/Documentation/dev-tools/kgdb.rst index 61293f40bc6e..d756c7b1c346 100644 --- a/Documentation/dev-tools/kgdb.rst +++ b/Documentation/dev-tools/kgdb.rst @@ -316,7 +316,7 @@ driver as a loadable kernel module kgdbwait will not do anything. Kernel parameter: ``kgdbcon`` ----------------------------- -The ``kgdbcon`` feature allows you to see :c:func:`printk` messages inside gdb +The ``kgdbcon`` feature allows you to see printk() messages inside gdb while gdb is connected to the kernel. Kdb does not make use of the kgdbcon feature. @@ -432,7 +432,7 @@ This is a quick example of how to use kdb. ``ps`` Displays only the active processes ``ps A`` Shows all the processes ``summary`` Shows kernel version info and memory usage - ``bt`` Get a backtrace of the current process using :c:func:`dump_stack` + ``bt`` Get a backtrace of the current process using dump_stack() ``dmesg`` View the kernel syslog buffer ``go`` Continue the system =========== ================================================================= @@ -724,7 +724,7 @@ The kernel debugger is organized into a number of components: The arch-specific portion implements: - contains an arch-specific trap catcher which invokes - :c:func:`kgdb_handle_exception` to start kgdb about doing its work + kgdb_handle_exception() to start kgdb about doing its work - translation to and from gdb specific packet format to :c:type:`pt_regs` @@ -769,7 +769,7 @@ The kernel debugger is organized into a number of components: config. Later run ``modprobe kdb_hello`` and the next time you enter the kdb shell, you can run the ``hello`` command. - - The implementation for :c:func:`kdb_printf` which emits messages directly + - The implementation for kdb_printf() which emits messages directly to I/O drivers, bypassing the kernel log. - SW / HW breakpoint management for the kdb shell @@ -875,7 +875,7 @@ kernel when ``CONFIG_KDB_KEYBOARD=y`` is set in the kernel configuration. The core polled keyboard driver driver for PS/2 type keyboards is in ``drivers/char/kdb_keyboard.c``. This driver is hooked into the debug core when kgdboc populates the callback in the array called -:c:type:`kdb_poll_funcs[]`. The :c:func:`kdb_get_kbd_char` is the top-level +:c:type:`kdb_poll_funcs[]`. The kdb_get_kbd_char() is the top-level function which polls hardware for single character input. kgdboc and kms @@ -887,10 +887,10 @@ that you have a video driver which has a frame buffer console and atomic kernel mode setting support. Every time the kernel debugger is entered it calls -:c:func:`kgdboc_pre_exp_handler` which in turn calls :c:func:`con_debug_enter` +kgdboc_pre_exp_handler() which in turn calls con_debug_enter() in the virtual console layer. On resuming kernel execution, the kernel -debugger calls :c:func:`kgdboc_post_exp_handler` which in turn calls -:c:func:`con_debug_leave`. +debugger calls kgdboc_post_exp_handler() which in turn calls +con_debug_leave(). Any video driver that wants to be compatible with the kernel debugger and the atomic kms callbacks must implement the ``mode_set_base_atomic``, -- 2.27.0 _______________________________________________ Linux-kernel-mentees mailing list Linux-kernel-mentees@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees