diff mbox series

docs: Kconfig: fix defconfig description

Message ID 20250227122320.153393-1-satoru.takeuchi@gmail.com (mailing list archive)
State New
Headers show
Series docs: Kconfig: fix defconfig description | expand

Commit Message

Satoru Takeuchi Feb. 27, 2025, 12:23 p.m. UTC
The commit 2a86f6612164 remved arch/$ARCH/defconfig.

Signed-off-by: Satoru Takeuchi <satoru.takeuchi@gmail.com>
---
 Documentation/admin-guide/README.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Miguel Ojeda Feb. 27, 2025, 3:43 p.m. UTC | #1
On Thu, Feb 27, 2025 at 1:26 PM Satoru Takeuchi
<satoru.takeuchi@gmail.com> wrote:
>
> The commit 2a86f6612164 remved arch/$ARCH/defconfig.

Nit: typo "removed".

In general, commit references should use the commit ...... ("......")
formatting, e.g.

    2a86f6612164 ("kbuild: use KBUILD_DEFCONFIG as the fallback for
DEFCONFIG_LIST")

In addition, if it is a fix for a previous commit, this typically
would be a "Fixes:" tag:

    Fixes: 2a86f6612164 ("kbuild: use KBUILD_DEFCONFIG as the fallback
for DEFCONFIG_LIST")

Details about these two notes can be found in:

    https://docs.kernel.org/process/submitting-patches.html#describe-your-changes

Thanks for the patch!

Cheers,
Miguel
diff mbox series

Patch

diff --git a/Documentation/admin-guide/README.rst b/Documentation/admin-guide/README.rst
index eb9452668909..b557cf1c820d 100644
--- a/Documentation/admin-guide/README.rst
+++ b/Documentation/admin-guide/README.rst
@@ -176,7 +176,7 @@  Configuring the kernel
                         values without prompting.
 
      "make defconfig"   Create a ./.config file by using the default
-                        symbol values from either arch/$ARCH/defconfig
+                        symbol values from either arch/$ARCH/configs/defconfig
                         or arch/$ARCH/configs/${PLATFORM}_defconfig,
                         depending on the architecture.