[Buildroot] [PATCH] Documentation patch with some small things that threw me off as a newcomer to the project.

[Buildroot] [PATCH] Documentation patch with some small things that threw me off as a newcomer to the project.

[j12i]

From: j12i <j+buildroot@maschinengott.de>

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 <whatever_board>_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 <whatever_board>_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</a> through the
 	  <a href="http://lists.buildroot.org/mailman/listinfo/buildroot">mailing list
 	</a></li>
+	<li><a href="https://gitlab.com/buildroot.org/buildroot">The git repo of buildroot's source code is on gitlab
+	</a></li>
       </ul>
 
       <p>For more details on these topics, check out the
-- 
2.46.2

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH] Documentation patch with some small things that threw me off as a newcomer to the project.

[j+buildroot-list]

Could somebody take a look at this? It might not be much, but I think 
it's still a big improvement for newcomers to the project. (Especially 
the change in quickstart.adoc.)

On 22.11.24 23:31, j12i wrote:
> From: j12i <j+buildroot@maschinengott.de>
> 
> 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 <whatever_board>_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 <whatever_board>_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</a> through the
>   	  <a href="http://lists.buildroot.org/mailman/listinfo/buildroot">mailing list
>   	</a></li>
> +	<li><a href="https://gitlab.com/buildroot.org/buildroot">The git repo of buildroot's source code is on gitlab
> +	</a></li>
>         </ul>
>   
>         <p>For more details on these topics, check out the

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH] Documentation patch with some small things that threw me off as a newcomer to the project.

[Thomas Petazzoni via buildroot]

Hello,

On Fri, 22 Nov 2024 23:31:58 +0100
j12i <j+buildroot-list@maschinengott.de> wrote:

> From: j12i <j+buildroot@maschinengott.de>
> 
> 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.  

Thanks a lot for your patch! Your proposed changes look sensible and
relevant. They may require a few tweaks when being applied, but overall
most likely they make sense.

However, in order for your patch to be applicable, we need:

- It to be sent with your real name

- It to have your Signed-off-by line

Could you check this and send a new iteration?

Thanks a lot!

Thomas
-- 
Thomas Petazzoni, co-owner and CEO, Bootlin
Embedded Linux and Kernel engineering and training
https://bootlin.com
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot