[PATCH 0/7] README: start cleanup

[PATCH 0/7] README: start cleanup

[Heinrich Schuchardt]

Our main README file contains information that

* is outdated
* should be moved to the HTML documentation
* is redundant to existing HTML documenation

Let's start cleaning up.

Heinrich Schuchardt (7):
  README: correct path to sandbox.rst
  README: rework contribution advices
  README: remove NetBSD section
  README: replace references to CHANGELOG
  doc: move 'Reproducible builds'
  README: remove section 'Versioning'
  doc: move directory hierarchy to HTML

 README                      | 222 +++---------------------------------
 doc/build/index.rst         |   1 +
 doc/build/reproducible.rst  |  25 ++++
 doc/develop/directories.rst |  76 ++++++++++++
 doc/develop/index.rst       |   1 +
 5 files changed, 116 insertions(+), 209 deletions(-)
 create mode 100644 doc/build/reproducible.rst
 create mode 100644 doc/develop/directories.rst

-- 
2.38.1

[PATCH 1/7] README: correct path to sandbox.rst

[Heinrich Schuchardt]

sandbox.rst was moved.

Fixes: 2851cc94f301 ("dm: Add documentation for host command and implementation")
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 README | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README b/README
index 40619ee40c..24e91b9a1f 100644
--- a/README
+++ b/README
@@ -189,7 +189,7 @@ board. This allows feature development which is not board- or architecture-
 specific to be undertaken on a native platform. The sandbox is also used to
 run some of U-Boot's tests.
 
-See doc/arch/sandbox.rst for more details.
+See doc/arch/sandbox/sandbox.rst for more details.
 
 
 Board Initialisation Flow:
-- 
2.38.1

[PATCH 2/7] README: rework contribution advices

[Heinrich Schuchardt]

Remove description of coding standards and patch submission process.
Link to the relevant HTML documentation instead.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 README | 110 ++++-----------------------------------------------------
 1 file changed, 6 insertions(+), 104 deletions(-)

diff --git a/README b/README
index 24e91b9a1f..f5db75d913 100644
--- a/README
+++ b/README
@@ -2862,108 +2862,10 @@ void no_more_time (int sig)
 }
 
 
-Coding Standards:
------------------
-
-All contributions to U-Boot should conform to the Linux kernel
-coding style; see the kernel coding style guide at
-https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
-script "scripts/Lindent" in your Linux kernel source directory.
-
-Source files originating from a different project (for example the
-MTD subsystem) are generally exempt from these guidelines and are not
-reformatted to ease subsequent migration to newer versions of those
-sources.
-
-Please note that U-Boot is implemented in C (and to some small parts in
-Assembler); no C++ is used, so please do not use C++ style comments (//)
-in your code.
-
-Please also stick to the following formatting rules:
-- remove any trailing white space
-- use TAB characters for indentation and vertical alignment, not spaces
-- make sure NOT to use DOS '\r\n' line feeds
-- do not add more than 2 consecutive empty lines to source files
-- do not add trailing empty lines to source files
-
-Submissions which do not conform to the standards may be returned
-with a request to reformat the changes.
-
-
-Submitting Patches:
--------------------
-
-Since the number of patches for U-Boot is growing, we need to
-establish some rules. Submissions which do not conform to these rules
-may be rejected, even when they contain important and valuable stuff.
-
-Please see https://www.denx.de/wiki/U-Boot/Patches for details.
-
-Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
-see https://lists.denx.de/listinfo/u-boot
-
-When you send a patch, please include the following information with
-it:
-
-* For bug fixes: a description of the bug and how your patch fixes
-  this bug. Please try to include a way of demonstrating that the
-  patch actually fixes something.
-
-* For new features: a description of the feature and your
-  implementation.
-
-* For major contributions, add a MAINTAINERS file with your
-  information and associated file and directory references.
-
-* When you add support for a new board, don't forget to add a
-  maintainer e-mail address to the boards.cfg file, too.
-
-* If your patch adds new configuration options, don't forget to
-  document these in the README file.
-
-* The patch itself. If you are using git (which is *strongly*
-  recommended) you can easily generate the patch using the
-  "git format-patch". If you then use "git send-email" to send it to
-  the U-Boot mailing list, you will avoid most of the common problems
-  with some other mail clients.
-
-  If you cannot use git, use "diff -purN OLD NEW". If your version of
-  diff does not support these options, then get the latest version of
-  GNU diff.
-
-  The current directory when running this command shall be the parent
-  directory of the U-Boot source tree (i. e. please make sure that
-  your patch includes sufficient directory information for the
-  affected files).
-
-  We prefer patches as plain text. MIME attachments are discouraged,
-  and compressed attachments must not be used.
-
-* If one logical set of modifications affects or creates several
-  files, all these changes shall be submitted in a SINGLE patch file.
-
-* Changesets that contain different, unrelated modifications shall be
-  submitted as SEPARATE patches, one patch per changeset.
-
-
-Notes:
-
-* Before sending the patch, run the buildman script on your patched
-  source tree and make sure that no errors or warnings are reported
-  for any of the boards.
-
-* Keep your modifications to the necessary minimum: A patch
-  containing several unrelated changes or arbitrary reformats will be
-  returned with a request to re-formatting / split it.
-
-* If you modify existing code, make sure that your new code does not
-  add to the memory footprint of the code ;-) Small is beautiful!
-  When adding new features, these should compile conditionally only
-  (using #ifdef), and the resulting code with the new feature
-  disabled must not need more memory than the old code without your
-  modification.
+Contributing
+============
 
-* Remember that there is a size limit of 100 kB per message on the
-  u-boot mailing list. Bigger patches will be moderated. If they are
-  reasonable and not too big, they will be acknowledged. But patches
-  bigger than the size limit should be avoided.
+The U-Boot projects depends on contributions from the user community.
+If you want to participate, please, have a look at the 'General'
+section of https://u-boot.readthedocs.io/en/latest/develop/index.html
+where we describe coding standards and the patch submission process.
-- 
2.38.1

[PATCH 3/7] README: remove NetBSD section

[Heinrich Schuchardt]

The information in this section is outdated.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 README | 29 -----------------------------
 1 file changed, 29 deletions(-)

diff --git a/README b/README
index f5db75d913..b4bfe39f81 100644
--- a/README
+++ b/README
@@ -2526,35 +2526,6 @@ configuration to your "File transfer protocols" section:
 	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
 
 
-NetBSD Notes:
-=============
-
-Starting at version 0.9.2, U-Boot supports NetBSD both as host
-(build U-Boot) and target system (boots NetBSD/mpc8xx).
-
-Building requires a cross environment; it is known to work on
-NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
-need gmake since the Makefiles are not compatible with BSD make).
-Note that the cross-powerpc package does not install include files;
-attempting to build U-Boot will fail because <machine/ansi.h> is
-missing.  This file has to be installed and patched manually:
-
-	# cd /usr/pkg/cross/powerpc-netbsd/include
-	# mkdir powerpc
-	# ln -s powerpc machine
-	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
-	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
-
-Native builds *don't* work due to incompatibilities between native
-and U-Boot include files.
-
-Booting assumes that (the first part of) the image booted is a
-stage-2 loader which in turn loads and then invokes the kernel
-proper. Loader sources will eventually appear in the NetBSD source
-tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
-meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
-
-
 Implementation Internals:
 =========================
 
-- 
2.38.1

[PATCH 4/7] README: replace references to CHANGELOG

[Heinrich Schuchardt]

Board configurations are in configs/ and not in the Makefile.

git log is the adequate way to identify who contributed to our source.
scripts/get_maintainer.pl is the correct way to identify maintainers.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 README | 16 ++++++----------
 1 file changed, 6 insertions(+), 10 deletions(-)

diff --git a/README b/README
index b4bfe39f81..a969fc7a97 100644
--- a/README
+++ b/README
@@ -28,20 +28,16 @@ load and run it dynamically.
 Status:
 =======
 
-In general, all boards for which a configuration option exists in the
-Makefile have been tested to some extent and can be considered
+In general, all boards for which a default configuration file exists in the
+configs/ directory have been tested to some extent and can be considered
 "working". In fact, many of them are used in production systems.
 
-In case of problems see the CHANGELOG file to find out who contributed
-the specific port. In addition, there are various MAINTAINERS files
-scattered throughout the U-Boot source identifying the people or
-companies responsible for various boards and subsystems.
+In case of problems you can use
 
-Note: As of August, 2010, there is no longer a CHANGELOG file in the
-actual U-Boot source tree; however, it can be created dynamically
-from the Git log using:
+     scripts/get_maintainer.pl <path>
 
-	make CHANGELOG
+to identify the people or companies responsible for various boards and
+subsystems. Or have a look at the git log.
 
 
 Where to get help:
-- 
2.38.1

[PATCH 5/7] doc: move 'Reproducible builds'

[Heinrich Schuchardt]

Move the README section to the HTML documentation.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 README                     | 11 -----------
 doc/build/index.rst        |  1 +
 doc/build/reproducible.rst | 25 +++++++++++++++++++++++++
 3 files changed, 26 insertions(+), 11 deletions(-)
 create mode 100644 doc/build/reproducible.rst

diff --git a/README b/README
index a969fc7a97..48db535556 100644
--- a/README
+++ b/README
@@ -1713,17 +1713,6 @@ This firmware often needs to be loaded during U-Boot booting.
 - CONFIG_SYS_MC_RSV_MEM_ALIGN
 	Define alignment of reserved memory MC requires
 
-Reproducible builds
--------------------
-
-In order to achieve reproducible builds, timestamps used in the U-Boot build
-process have to be set to a fixed value.
-
-This is done using the SOURCE_DATE_EPOCH environment variable.
-SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
-option for U-Boot or an environment variable in U-Boot.
-
-SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
 
 Building the Software:
 ======================
diff --git a/doc/build/index.rst b/doc/build/index.rst
index dc9cde4001..64e66491bd 100644
--- a/doc/build/index.rst
+++ b/doc/build/index.rst
@@ -9,6 +9,7 @@ Build U-Boot
    source
    gcc
    clang
+   reproducible
    docker
    tools
    buildman
diff --git a/doc/build/reproducible.rst b/doc/build/reproducible.rst
new file mode 100644
index 0000000000..5423080633
--- /dev/null
+++ b/doc/build/reproducible.rst
@@ -0,0 +1,25 @@
+Reproducible builds
+===================
+
+In order to achieve reproducible builds, timestamps used in the U-Boot build
+process have to be set to a fixed value.
+
+This is done using the SOURCE_DATE_EPOCH environment variable which specifies
+the number of seconds since 1970-01-01T00:00:00Z.
+
+Example
+-------
+
+To build the sandbox with 2023-01-01T00:00:00Z as timestamp we can use:
+
+.. code-block:: bash
+
+    make sandbox_defconfig
+    SOURCE_DATE_EPOCH=1672531200 make
+
+This date is shown when we launch U-Boot:
+
+.. code-block:: console
+
+    ./u-boot -T
+    U-Boot 2023.01 (Jan 01 2023 - 00:00:00 +0000)
-- 
2.38.1

[PATCH 6/7] README: remove section 'Versioning'

[Heinrich Schuchardt]

The information is already maintained in doc/develop/release_cycle.rst.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 README | 16 ----------------
 1 file changed, 16 deletions(-)

diff --git a/README b/README
index 48db535556..5437a1bdc2 100644
--- a/README
+++ b/README
@@ -105,22 +105,6 @@ the string "u_boot" or on "U_BOOT". Example:
 	IH_OS_U_BOOT		u_boot_hush_start
 
 
-Versioning:
-===========
-
-Starting with the release in October 2008, the names of the releases
-were changed from numerical release numbers without deeper meaning
-into a time stamp based numbering. Regular releases are identified by
-names consisting of the calendar year and month of the release date.
-Additional fields (if present) indicate release candidates or bug fix
-releases in "stable" maintenance trees.
-
-Examples:
-	U-Boot v2009.11	    - Release November 2009
-	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
-	U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
-
-
 Directory Hierarchy:
 ====================
 
-- 
2.38.1

[PATCH 7/7] doc: move directory hierarchy to HTML

[Heinrich Schuchardt]

Move section 'Directory hierarchy' from file README to the HTML
documentation.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 README                      | 38 -------------------
 doc/develop/directories.rst | 76 +++++++++++++++++++++++++++++++++++++
 doc/develop/index.rst       |  1 +
 3 files changed, 77 insertions(+), 38 deletions(-)
 create mode 100644 doc/develop/directories.rst

diff --git a/README b/README
index 5437a1bdc2..8b395356dc 100644
--- a/README
+++ b/README
@@ -105,44 +105,6 @@ the string "u_boot" or on "U_BOOT". Example:
 	IH_OS_U_BOOT		u_boot_hush_start
 
 
-Directory Hierarchy:
-====================
-
-/arch			Architecture-specific files
-  /arc			Files generic to ARC architecture
-  /arm			Files generic to ARM architecture
-  /m68k			Files generic to m68k architecture
-  /microblaze		Files generic to microblaze architecture
-  /mips			Files generic to MIPS architecture
-  /nios2		Files generic to Altera NIOS2 architecture
-  /powerpc		Files generic to PowerPC architecture
-  /riscv		Files generic to RISC-V architecture
-  /sandbox		Files generic to HW-independent "sandbox"
-  /sh			Files generic to SH architecture
-  /x86			Files generic to x86 architecture
-  /xtensa		Files generic to Xtensa architecture
-/api			Machine/arch-independent API for external apps
-/board			Board-dependent files
-/boot			Support for images and booting
-/cmd			U-Boot commands functions
-/common			Misc architecture-independent functions
-/configs		Board default configuration files
-/disk			Code for disk drive partition handling
-/doc			Documentation (a mix of ReST and READMEs)
-/drivers		Device drivers
-/dts			Makefile for building internal U-Boot fdt.
-/env			Environment support
-/examples		Example code for standalone applications, etc.
-/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
-/include		Header Files
-/lib			Library routines generic to all architectures
-/Licenses		Various license files
-/net			Networking code
-/post			Power On Self Test
-/scripts		Various build scripts and Makefiles
-/test			Various unit test files
-/tools			Tools to build and sign FIT images, etc.
-
 Software Configuration:
 =======================
 
diff --git a/doc/develop/directories.rst b/doc/develop/directories.rst
new file mode 100644
index 0000000000..112b5655f6
--- /dev/null
+++ b/doc/develop/directories.rst
@@ -0,0 +1,76 @@
+Directory hierarchy
+===================
+
+.. list-table::
+   :header-rows: 1
+
+   * - Directory path
+     - Usage
+   * - /arch
+     - Architecture-specific files
+   * - /arch/arc
+     - Files relating to ARC architecture
+   * - /arch/arm
+     - Files relating to ARM architecture
+   * - /arch/m68k
+     - Files relating to m68k architecture
+   * - /arch/microblaze
+     - Files relating to microblaze architecture
+   * - /arch/mips
+     - Files relating to MIPS architecture
+   * - /arch/nios2
+     - Files relating to Altera NIOS2 architecture
+   * - /arch/powerpc
+     - Files relating to PowerPC architecture
+   * - /arch/riscv
+     - Files relating to RISC-V architecture
+   * - /arch/sandbox
+     - Files relating to HW-independent "sandbox"
+   * - /arch/sh
+     - Files relating to SH architecture
+   * - /arch/x86
+     - Files relating to x86 architecture
+   * - /arch/xtensa
+     - Files relating to Xtensa architecture
+   * - /api
+     - Machine/arch-independent API for external apps
+   * - /board
+     - Board-dependent files
+   * - /boot
+     - Support for images and booting
+   * - /cmd
+     - U-Boot commands functions
+   * - /common
+     - Misc architecture-independent functions
+   * - /configs
+     - Board default configuration files
+   * - /disk
+     - Code for disk drive partition handling
+   * - /doc
+     - Documentation (a mix of ReST and READMEs)
+   * - /drivers
+     - Device drivers
+   * - /dts
+     - Makefile for building internal U-Boot fdt.
+   * - /env
+     - Environment support
+   * - /examples
+     - Example code for standalone applications, etc.
+   * - /fs
+     - Filesystem code (cramfs, ext2, jffs2, etc.)
+   * - /include
+     - Header Files
+   * - /lib
+     - Library routines relating to all architectures
+   * - /Licenses
+     - Various license files
+   * - /net
+     - Networking code
+   * - /post
+     - Power On Self Test
+   * - /scripts
+     - Various build scripts and Makefiles
+   * - /test
+     - Various unit test files
+   * - /tools
+     - Tools to build and sign FIT images, etc.
diff --git a/doc/develop/index.rst b/doc/develop/index.rst
index 79d7736b13..a52ad630d0 100644
--- a/doc/develop/index.rst
+++ b/doc/develop/index.rst
@@ -24,6 +24,7 @@ Implementation
 .. toctree::
    :maxdepth: 1
 
+   directories
    bloblist
    bootstd
    ci_testing
-- 
2.38.1

Re: [PATCH 2/7] README: rework contribution advices

[Tom Rini]

[-- Attachment #1: Type: text/plain, Size: 332 bytes --]

On Wed, Jan 25, 2023 at 07:14:57PM +0100, Heinrich Schuchardt wrote:

> Remove description of coding standards and patch submission process.
> Link to the relevant HTML documentation instead.
> 
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>

Reviewed-by: Tom Rini <trini@konsulko.com>

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]

Re: [PATCH 3/7] README: remove NetBSD section

[Tom Rini]

[-- Attachment #1: Type: text/plain, Size: 256 bytes --]

On Wed, Jan 25, 2023 at 07:14:58PM +0100, Heinrich Schuchardt wrote:

> The information in this section is outdated.
> 
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>

Reviewed-by: Tom Rini <trini@konsulko.com>

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]

Re: [PATCH 4/7] README: replace references to CHANGELOG

[Tom Rini]

[-- Attachment #1: Type: text/plain, Size: 651 bytes --]

On Wed, Jan 25, 2023 at 07:14:59PM +0100, Heinrich Schuchardt wrote:

> Board configurations are in configs/ and not in the Makefile.
> 
> git log is the adequate way to identify who contributed to our source.
> scripts/get_maintainer.pl is the correct way to identify maintainers.
> 
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>

Reviewed-by: Tom Rini <trini@konsulko.com>

But is there some rST doc this should be in as well?  Long term and high
level, the README should just tell people how to build the documentation
or to read the markdown files directly, starting with the top level
index.

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]

Re: [PATCH 5/7] doc: move 'Reproducible builds'

[Tom Rini]

[-- Attachment #1: Type: text/plain, Size: 262 bytes --]

On Wed, Jan 25, 2023 at 07:15:00PM +0100, Heinrich Schuchardt wrote:

> Move the README section to the HTML documentation.
> 
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>

Reviewed-by: Tom Rini <trini@konsulko.com>

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]

Re: [PATCH 6/7] README: remove section 'Versioning'

[Tom Rini]

[-- Attachment #1: Type: text/plain, Size: 283 bytes --]

On Wed, Jan 25, 2023 at 07:15:01PM +0100, Heinrich Schuchardt wrote:

> The information is already maintained in doc/develop/release_cycle.rst.
> 
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>

Reviewed-by: Tom Rini <trini@konsulko.com>

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]

Re: [PATCH 7/7] doc: move directory hierarchy to HTML

[Tom Rini]

[-- Attachment #1: Type: text/plain, Size: 293 bytes --]

On Wed, Jan 25, 2023 at 07:15:02PM +0100, Heinrich Schuchardt wrote:

> Move section 'Directory hierarchy' from file README to the HTML
> documentation.
> 
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>

Reviewed-by: Tom Rini <trini@konsulko.com>

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]

Re: [PATCH 2/7] README: rework contribution advices

[Simon Glass]

On Wed, 25 Jan 2023 at 11:15, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> Remove description of coding standards and patch submission process.
> Link to the relevant HTML documentation instead.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  README | 110 ++++-----------------------------------------------------
>  1 file changed, 6 insertions(+), 104 deletions(-)
>

Reviewed-by: Simon Glass <sjg@chromium.org>

Suggestion below

> diff --git a/README b/README
> index 24e91b9a1f..f5db75d913 100644
> --- a/README
> +++ b/README
> @@ -2862,108 +2862,10 @@ void no_more_time (int sig)
>  }
>
>
> -Coding Standards:
> ------------------
> -
> -All contributions to U-Boot should conform to the Linux kernel
> -coding style; see the kernel coding style guide at
> -https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
> -script "scripts/Lindent" in your Linux kernel source directory.
> -
> -Source files originating from a different project (for example the
> -MTD subsystem) are generally exempt from these guidelines and are not
> -reformatted to ease subsequent migration to newer versions of those
> -sources.
> -
> -Please note that U-Boot is implemented in C (and to some small parts in
> -Assembler); no C++ is used, so please do not use C++ style comments (//)
> -in your code.
> -
> -Please also stick to the following formatting rules:
> -- remove any trailing white space
> -- use TAB characters for indentation and vertical alignment, not spaces
> -- make sure NOT to use DOS '\r\n' line feeds
> -- do not add more than 2 consecutive empty lines to source files
> -- do not add trailing empty lines to source files
> -
> -Submissions which do not conform to the standards may be returned
> -with a request to reformat the changes.
> -
> -
> -Submitting Patches:
> --------------------
> -
> -Since the number of patches for U-Boot is growing, we need to
> -establish some rules. Submissions which do not conform to these rules
> -may be rejected, even when they contain important and valuable stuff.
> -
> -Please see https://www.denx.de/wiki/U-Boot/Patches for details.
> -
> -Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
> -see https://lists.denx.de/listinfo/u-boot
> -
> -When you send a patch, please include the following information with
> -it:
> -
> -* For bug fixes: a description of the bug and how your patch fixes
> -  this bug. Please try to include a way of demonstrating that the
> -  patch actually fixes something.
> -
> -* For new features: a description of the feature and your
> -  implementation.
> -
> -* For major contributions, add a MAINTAINERS file with your
> -  information and associated file and directory references.
> -
> -* When you add support for a new board, don't forget to add a
> -  maintainer e-mail address to the boards.cfg file, too.
> -
> -* If your patch adds new configuration options, don't forget to
> -  document these in the README file.
> -
> -* The patch itself. If you are using git (which is *strongly*
> -  recommended) you can easily generate the patch using the
> -  "git format-patch". If you then use "git send-email" to send it to
> -  the U-Boot mailing list, you will avoid most of the common problems
> -  with some other mail clients.
> -
> -  If you cannot use git, use "diff -purN OLD NEW". If your version of
> -  diff does not support these options, then get the latest version of
> -  GNU diff.
> -
> -  The current directory when running this command shall be the parent
> -  directory of the U-Boot source tree (i. e. please make sure that
> -  your patch includes sufficient directory information for the
> -  affected files).
> -
> -  We prefer patches as plain text. MIME attachments are discouraged,
> -  and compressed attachments must not be used.
> -
> -* If one logical set of modifications affects or creates several
> -  files, all these changes shall be submitted in a SINGLE patch file.
> -
> -* Changesets that contain different, unrelated modifications shall be
> -  submitted as SEPARATE patches, one patch per changeset.
> -
> -
> -Notes:
> -
> -* Before sending the patch, run the buildman script on your patched
> -  source tree and make sure that no errors or warnings are reported
> -  for any of the boards.
> -
> -* Keep your modifications to the necessary minimum: A patch
> -  containing several unrelated changes or arbitrary reformats will be
> -  returned with a request to re-formatting / split it.
> -
> -* If you modify existing code, make sure that your new code does not
> -  add to the memory footprint of the code ;-) Small is beautiful!
> -  When adding new features, these should compile conditionally only
> -  (using #ifdef), and the resulting code with the new feature
> -  disabled must not need more memory than the old code without your
> -  modification.
> +Contributing
> +============
>
> -* Remember that there is a size limit of 100 kB per message on the
> -  u-boot mailing list. Bigger patches will be moderated. If they are
> -  reasonable and not too big, they will be acknowledged. But patches
> -  bigger than the size limit should be avoided.
> +The U-Boot projects depends on contributions from the user community.

project

> +If you want to participate, please, have a look at the 'General'

To participate, please have a look

> +section of https://u-boot.readthedocs.io/en/latest/develop/index.html
> +where we describe coding standards and the patch submission process.

Should we mention the mailing list and irc?

Regards,
Simon

Re: [PATCH 3/7] README: remove NetBSD section

[Simon Glass]

On Wed, 25 Jan 2023 at 11:15, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> The information in this section is outdated.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  README | 29 -----------------------------
>  1 file changed, 29 deletions(-)

Reviewed-by: Simon Glass <sjg@chromium.org>

Re: [PATCH 4/7] README: replace references to CHANGELOG

[Simon Glass]

On Wed, 25 Jan 2023 at 11:15, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> Board configurations are in configs/ and not in the Makefile.
>
> git log is the adequate way to identify who contributed to our source.
> scripts/get_maintainer.pl is the correct way to identify maintainers.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  README | 16 ++++++----------
>  1 file changed, 6 insertions(+), 10 deletions(-)
>

Reviewed-by: Simon Glass <sjg@chromium.org>

Re: [PATCH 6/7] README: remove section 'Versioning'

[Simon Glass]

On Wed, 25 Jan 2023 at 11:15, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> The information is already maintained in doc/develop/release_cycle.rst.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  README | 16 ----------------
>  1 file changed, 16 deletions(-)
>

Reviewed-by: Simon Glass <sjg@chromium.org>

Re: [PATCH 7/7] doc: move directory hierarchy to HTML

[Simon Glass]

On Wed, 25 Jan 2023 at 11:15, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> Move section 'Directory hierarchy' from file README to the HTML
> documentation.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  README                      | 38 -------------------
>  doc/develop/directories.rst | 76 +++++++++++++++++++++++++++++++++++++
>  doc/develop/index.rst       |  1 +
>  3 files changed, 77 insertions(+), 38 deletions(-)
>  create mode 100644 doc/develop/directories.rst
>

Reviewed-by: Simon Glass <sjg@chromium.org>

Re: [PATCH 5/7] doc: move 'Reproducible builds'

[Simon Glass]

On Wed, 25 Jan 2023 at 11:15, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> Move the README section to the HTML documentation.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  README                     | 11 -----------
>  doc/build/index.rst        |  1 +
>  doc/build/reproducible.rst | 25 +++++++++++++++++++++++++
>  3 files changed, 26 insertions(+), 11 deletions(-)
>  create mode 100644 doc/build/reproducible.rst

Reviewed-by: Simon Glass <sjg@chromium.org>

Re: [PATCH 1/7] README: correct path to sandbox.rst

[Simon Glass]

On Wed, 25 Jan 2023 at 11:15, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> sandbox.rst was moved.
>
> Fixes: 2851cc94f301 ("dm: Add documentation for host command and implementation")
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  README | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>

Reviewed-by: Simon Glass <sjg@chromium.org>

Re: [PATCH 4/7] README: replace references to CHANGELOG

[Heinrich Schuchardt]

On 1/25/23 23:33, Tom Rini wrote:
> On Wed, Jan 25, 2023 at 07:14:59PM +0100, Heinrich Schuchardt wrote:
> 
>> Board configurations are in configs/ and not in the Makefile.
>>
>> git log is the adequate way to identify who contributed to our source.
>> scripts/get_maintainer.pl is the correct way to identify maintainers.
>>
>> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> 
> Reviewed-by: Tom Rini <trini@konsulko.com>
> 
> But is there some rST doc this should be in as well?  Long term and high

Directory configs/ is mentioned in:
https://u-boot.readthedocs.io/en/latest/build/gcc.html#configuration

get_maintainer.pl is not mentioned in doc/ yet.

> level, the README should just tell people how to build the documentation
> or to read the markdown files directly, starting with the top level
> index.
> 

Yes we should get rid of the 2000+ lines in README.

Best regards

Heinrich