From patchwork Fri Nov 22 22:31:58 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: j12i X-Patchwork-Id: 2014391 Return-Path: X-Original-To: incoming-buildroot@patchwork.ozlabs.org Delivered-To: patchwork-incoming-buildroot@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=buildroot.org (client-ip=2605:bc80:3010::137; helo=smtp4.osuosl.org; envelope-from=buildroot-bounces@buildroot.org; receiver=patchwork.ozlabs.org) Received: from smtp4.osuosl.org (smtp4.osuosl.org [IPv6:2605:bc80:3010::137]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (secp384r1) server-digest SHA384) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4Xw8wx31gfz1ySM for ; Sat, 23 Nov 2024 09:32:17 +1100 (AEDT) Received: from localhost (localhost [127.0.0.1]) by smtp4.osuosl.org (Postfix) with ESMTP id F082C423BF; Fri, 22 Nov 2024 22:32:14 +0000 (UTC) X-Virus-Scanned: amavis at osuosl.org Received: from smtp4.osuosl.org ([127.0.0.1]) by localhost (smtp4.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP id HpM6z9259FRh; Fri, 22 Nov 2024 22:32:13 +0000 (UTC) X-Comment: SPF check N/A for local connections - client-ip=140.211.166.142; helo=lists1.osuosl.org; envelope-from=buildroot-bounces@buildroot.org; receiver= DKIM-Filter: OpenDKIM Filter v2.11.0 smtp4.osuosl.org A3CB8423DA Received: from lists1.osuosl.org (lists1.osuosl.org [140.211.166.142]) by smtp4.osuosl.org (Postfix) with ESMTP id A3CB8423DA; Fri, 22 Nov 2024 22:32:13 +0000 (UTC) X-Original-To: buildroot@buildroot.org Delivered-To: buildroot@buildroot.org Received: from smtp1.osuosl.org (smtp1.osuosl.org [IPv6:2605:bc80:3010::138]) by lists1.osuosl.org (Postfix) with ESMTP id F3A99E11 for ; Fri, 22 Nov 2024 22:32:11 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp1.osuosl.org (Postfix) with ESMTP id E255784A04 for ; Fri, 22 Nov 2024 22:32:11 +0000 (UTC) X-Virus-Scanned: amavis at osuosl.org Received: from smtp1.osuosl.org ([127.0.0.1]) by localhost (smtp1.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP id uC0h2nipdc2O for ; Fri, 22 Nov 2024 22:32:11 +0000 (UTC) Received-SPF: Pass (mailfrom) identity=mailfrom; client-ip=80.241.56.172; helo=mout-p-202.mailbox.org; envelope-from=j+buildroot-list@maschinengott.de; receiver= DMARC-Filter: OpenDMARC Filter v1.4.2 smtp1.osuosl.org BB4F2849F8 DKIM-Filter: OpenDKIM Filter v2.11.0 smtp1.osuosl.org BB4F2849F8 Received: from mout-p-202.mailbox.org (mout-p-202.mailbox.org [80.241.56.172]) by smtp1.osuosl.org (Postfix) with ESMTPS id BB4F2849F8 for ; Fri, 22 Nov 2024 22:32:10 +0000 (UTC) Received: from smtp102.mailbox.org (smtp102.mailbox.org [10.196.197.102]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by mout-p-202.mailbox.org (Postfix) with ESMTPS id 4Xw8wj2dZNz9t18 for ; Fri, 22 Nov 2024 23:32:05 +0100 (CET) From: j12i To: buildroot@buildroot.org Date: Fri, 22 Nov 2024 23:31:58 +0100 Message-ID: <20241122223158.5315-1-j+buildroot-list@maschinengott.de> MIME-Version: 1.0 X-Mailman-Original-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=maschinengott.de; s=MBO0001; t=1732314725; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=77n8KSp1ZqqgMfhgqN/AsWOPQj2FQbC7o/QOOP2JC9k=; b=1qSjf8rboBcrYDA+hyquvbYzXTPvvuG4aU6jaZ5BdlvjhAbZM44xy3TBnFRfwXvNc7OSN/ OZJbmqX+VSwMRE7uA4u9TKtwgz40NjH0DoCETRNVdMFCzOOkxn8dTMOeayt1XCalQQiVog TNFP0P2cbn/itFU6nvZxLADCRGkENeKXkgcTFM/e4Rvo/OikpXfrRcBMYVWrl6LgbIbgS2 IXdVTitBbvYIQBgOMEHDcTnmlNu+XIV9YOTx5mDh5dFqfLygtAwo8uWVR/0D9gyOtoPlGd bBZ5I7mZIs8FpiCUyoPF3x5h2CnEH94uhvNA51BaQiNCQnN73k90Ko4KYjPUQA== X-Mailman-Original-Authentication-Results: smtp1.osuosl.org; dmarc=pass (p=none dis=none) header.from=maschinengott.de X-Mailman-Original-Authentication-Results: smtp1.osuosl.org; dkim=pass (2048-bit key, unprotected) header.d=maschinengott.de header.i=@maschinengott.de header.a=rsa-sha256 header.s=MBO0001 header.b=1qSjf8rb Subject: [Buildroot] [PATCH] Documentation patch with some small things that threw me off as a newcomer to the project. X-BeenThere: buildroot@buildroot.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Discussion and development of buildroot List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: buildroot-bounces@buildroot.org Sender: "buildroot" From: j12i This is my first contribution to this project and at the same time my first time using git send-email. Please tell me if I'm doing it wrong, but don't get angry at me. This results from a conversation I had on IRC today with xogium. The change in docs/manual/getting.adoc is in reference to the following section in docs/manual/contribute.adoc: > Refer to Chapter 3, Getting Buildroot for more information on obtaining a Buildroot git tree. --- README | 2 ++ docs/manual/getting.adoc | 2 ++ docs/manual/quickstart.adoc | 11 +++++++++++ docs/website/contribute.html | 2 ++ 4 files changed, 17 insertions(+) diff --git a/README b/README index 008e996f5f..2fa1905f6b 100644 --- a/README +++ b/README @@ -7,6 +7,8 @@ Online documentation can be found at http://buildroot.org/docs.html To build and use the buildroot stuff, do the following: +0) (if you want to build an image for a specific board, run + 'make _defconfig' to have starting point) 1) run 'make menuconfig' 2) select the target architecture and the packages you wish to compile 3) run 'make' diff --git a/docs/manual/getting.adoc b/docs/manual/getting.adoc index 51c97d5793..f338fef2d6 100644 --- a/docs/manual/getting.adoc +++ b/docs/manual/getting.adoc @@ -10,6 +10,8 @@ November. Release numbers are in the format YYYY.MM, so for example Release tarballs are available at http://buildroot.org/downloads/[]. +https://gitlab.com/buildroot.org/buildroot[The git repo is on Gitlab]. + For your convenience, a https://www.vagrantup.com/[Vagrantfile] is available in `support/misc/Vagrantfile` in the Buildroot source tree to quickly set up a virtual machine with the needed dependencies to diff --git a/docs/manual/quickstart.adoc b/docs/manual/quickstart.adoc index 605031037f..42cd72a88b 100644 --- a/docs/manual/quickstart.adoc +++ b/docs/manual/quickstart.adoc @@ -8,6 +8,17 @@ is no need to be root to configure and use Buildroot. By running all commands as a regular user, you protect your system against packages behaving badly during compilation and installation. +[NOTE] +==== +This chapter just gives a general outline of the process to build an image. To build an image for a specific board, run + +---- + $ make _defconfig +---- + +first to base your work upon. +==== + The first step when using Buildroot is to create a configuration. Buildroot has a nice configuration tool similar to the one you can find in the http://www.kernel.org/[Linux kernel] or in diff --git a/docs/website/contribute.html b/docs/website/contribute.html index 52c30d60d3..4155fb96da 100644 --- a/docs/website/contribute.html +++ b/docs/website/contribute.html @@ -26,6 +26,8 @@ your own patches through the mailing list +
  • The git repo of buildroot's source code is on gitlab +
  • For more details on these topics, check out the