All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH 1/1] README: remove 'U-Boot Porting Guide' section
@ 2023-01-25 19:00 Heinrich Schuchardt
  2023-01-25 22:33 ` Tom Rini
  2023-01-25 23:49 ` Simon Glass
  0 siblings, 2 replies; 8+ messages in thread
From: Heinrich Schuchardt @ 2023-01-25 19:00 UTC (permalink / raw)
  To: Tom Rini; +Cc: Simon Glass, u-boot, Heinrich Schuchardt

This section does not match the standards of our documentation.

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

diff --git a/README b/README
index 8b395356dc..edce7890c0 100644
--- a/README
+++ b/README
@@ -2690,80 +2690,6 @@ running from ROM, and because the code will have to be relocated to a
 new address in RAM.
 
 
-U-Boot Porting Guide:
-----------------------
-
-[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
-list, October 2002]
-
-
-int main(int argc, char *argv[])
-{
-	sighandler_t no_more_time;
-
-	signal(SIGALRM, no_more_time);
-	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
-
-	if (available_money > available_manpower) {
-		Pay consultant to port U-Boot;
-		return 0;
-	}
-
-	Download latest U-Boot source;
-
-	Subscribe to u-boot mailing list;
-
-	if (clueless)
-		email("Hi, I am new to U-Boot, how do I get started?");
-
-	while (learning) {
-		Read the README file in the top level directory;
-		Read https://www.denx.de/wiki/bin/view/DULG/Manual;
-		Read applicable doc/README.*;
-		Read the source, Luke;
-		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
-	}
-
-	if (available_money > toLocalCurrency ($2500))
-		Buy a BDI3000;
-	else
-		Add a lot of aggravation and time;
-
-	if (a similar board exists) {	/* hopefully... */
-		cp -a board/<similar> board/<myboard>
-		cp include/configs/<similar>.h include/configs/<myboard>.h
-	} else {
-		Create your own board support subdirectory;
-		Create your own board include/configs/<myboard>.h file;
-	}
-	Edit new board/<myboard> files
-	Edit new include/configs/<myboard>.h
-
-	while (!accepted) {
-		while (!running) {
-			do {
-				Add / modify source code;
-			} until (compiles);
-			Debug;
-			if (clueless)
-				email("Hi, I am having problems...");
-		}
-		Send patch file to the U-Boot email list;
-		if (reasonable critiques)
-			Incorporate improvements from email list code review;
-		else
-			Defend code as written;
-	}
-
-	return 0;
-}
-
-void no_more_time (int sig)
-{
-      hire_a_guru();
-}
-
-
 Contributing
 ============
 
-- 
2.38.1


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] README: remove 'U-Boot Porting Guide' section
  2023-01-25 19:00 [PATCH 1/1] README: remove 'U-Boot Porting Guide' section Heinrich Schuchardt
@ 2023-01-25 22:33 ` Tom Rini
  2023-01-25 23:49 ` Simon Glass
  1 sibling, 0 replies; 8+ messages in thread
From: Tom Rini @ 2023-01-25 22:33 UTC (permalink / raw)
  To: Heinrich Schuchardt; +Cc: Simon Glass, u-boot

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

On Wed, Jan 25, 2023 at 08:00:23PM +0100, Heinrich Schuchardt wrote:

> This section does not match the standards of our 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 --]

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] README: remove 'U-Boot Porting Guide' section
  2023-01-25 19:00 [PATCH 1/1] README: remove 'U-Boot Porting Guide' section Heinrich Schuchardt
  2023-01-25 22:33 ` Tom Rini
@ 2023-01-25 23:49 ` Simon Glass
  2023-01-26  9:17   ` Heinrich Schuchardt
  1 sibling, 1 reply; 8+ messages in thread
From: Simon Glass @ 2023-01-25 23:49 UTC (permalink / raw)
  To: Heinrich Schuchardt; +Cc: Tom Rini, u-boot

Hi Heinrich,

On Wed, 25 Jan 2023 at 12:00, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> This section does not match the standards of our documentation.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  README | 74 ----------------------------------------------------------
>  1 file changed, 74 deletions(-)
>

It seems fairly accurate to me, and includes some good advice.

Regards,
Simon

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] README: remove 'U-Boot Porting Guide' section
  2023-01-25 23:49 ` Simon Glass
@ 2023-01-26  9:17   ` Heinrich Schuchardt
  2023-01-28 22:01     ` Simon Glass
  0 siblings, 1 reply; 8+ messages in thread
From: Heinrich Schuchardt @ 2023-01-26  9:17 UTC (permalink / raw)
  To: Simon Glass; +Cc: Tom Rini, u-boot

On 1/26/23 00:49, Simon Glass wrote:
> Hi Heinrich,
> 
> On Wed, 25 Jan 2023 at 12:00, Heinrich Schuchardt
> <heinrich.schuchardt@canonical.com> wrote:
>>
>> This section does not match the standards of our documentation.
>>
>> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
>> ---
>>   README | 74 ----------------------------------------------------------
>>   1 file changed, 74 deletions(-)
>>
> 
> It seems fairly accurate to me, and includes some good advice.
> 
> Regards,
> Simon

* That section tries to look funny. U-Boot is serious stuff.
* The information is outdated. BDI3000 is not on sale, 
https://www.denx.de/wiki/bin/view/DULG/Manual is no longer maintained.
* It contains advice that we would prefer not to give like
   email("Hi, I am new to U-Boot, how do I get started?")
* It is incomplete. You cannot introduce a new board without defconfig.

An introduction chapter for new developers in doc/develop/ would be helpful.

Best regards

Heinrich

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] README: remove 'U-Boot Porting Guide' section
  2023-01-26  9:17   ` Heinrich Schuchardt
@ 2023-01-28 22:01     ` Simon Glass
  2023-01-29 22:37       ` Heinrich Schuchardt
  0 siblings, 1 reply; 8+ messages in thread
From: Simon Glass @ 2023-01-28 22:01 UTC (permalink / raw)
  To: Heinrich Schuchardt; +Cc: Tom Rini, u-boot

Hi Heinrich,

On Thu, 26 Jan 2023 at 02:17, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> On 1/26/23 00:49, Simon Glass wrote:
> > Hi Heinrich,
> >
> > On Wed, 25 Jan 2023 at 12:00, Heinrich Schuchardt
> > <heinrich.schuchardt@canonical.com> wrote:
> >>
> >> This section does not match the standards of our documentation.
> >>
> >> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> >> ---
> >>   README | 74 ----------------------------------------------------------
> >>   1 file changed, 74 deletions(-)
> >>
> >
> > It seems fairly accurate to me, and includes some good advice.
> >
> > Regards,
> > Simon
>
> * That section tries to look funny. U-Boot is serious stuff.

Some people do have a sense of humour...but in any case it might be
better to reword it to meet your standards, rather than delete it?

> * The information is outdated. BDI3000 is not on sale,
> https://www.denx.de/wiki/bin/view/DULG/Manual is no longer maintained.
> * It contains advice that we would prefer not to give like
>    email("Hi, I am new to U-Boot, how do I get started?")
> * It is incomplete. You cannot introduce a new board without defconfig.
>
> An introduction chapter for new developers in doc/develop/ would be helpful.

OK, so how about updating it, then? Having nothing at all seems bad to me.

Regards,
Simon

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] README: remove 'U-Boot Porting Guide' section
  2023-01-28 22:01     ` Simon Glass
@ 2023-01-29 22:37       ` Heinrich Schuchardt
  2023-02-01 20:20         ` Simon Glass
  0 siblings, 1 reply; 8+ messages in thread
From: Heinrich Schuchardt @ 2023-01-29 22:37 UTC (permalink / raw)
  To: Simon Glass; +Cc: Tom Rini, u-boot



On 1/28/23 23:01, Simon Glass wrote:
> Hi Heinrich,
> 
> On Thu, 26 Jan 2023 at 02:17, Heinrich Schuchardt
> <heinrich.schuchardt@canonical.com> wrote:
>>
>> On 1/26/23 00:49, Simon Glass wrote:
>>> Hi Heinrich,
>>>
>>> On Wed, 25 Jan 2023 at 12:00, Heinrich Schuchardt
>>> <heinrich.schuchardt@canonical.com> wrote:
>>>>
>>>> This section does not match the standards of our documentation.
>>>>
>>>> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
>>>> ---
>>>>    README | 74 ----------------------------------------------------------
>>>>    1 file changed, 74 deletions(-)
>>>>
>>>
>>> It seems fairly accurate to me, and includes some good advice.
>>>
>>> Regards,
>>> Simon
>>
>> * That section tries to look funny. U-Boot is serious stuff.
> 
> Some people do have a sense of humour...but in any case it might be
> better to reword it to meet your standards, rather than delete it?
> 
>> * The information is outdated. BDI3000 is not on sale,
>> https://www.denx.de/wiki/bin/view/DULG/Manual is no longer maintained.
>> * It contains advice that we would prefer not to give like
>>     email("Hi, I am new to U-Boot, how do I get started?")
>> * It is incomplete. You cannot introduce a new board without defconfig.
>>
>> An introduction chapter for new developers in doc/develop/ would be helpful.
> 
> OK, so how about updating it, then? Having nothing at all seems bad to me.

As Tom wrote README should be minimal and point to the HTML 
documentation. So nothing to update here. Are you able to provide a 
chapter on porting boards?

Best regards

Heinrich

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] README: remove 'U-Boot Porting Guide' section
  2023-01-29 22:37       ` Heinrich Schuchardt
@ 2023-02-01 20:20         ` Simon Glass
  2023-02-02 16:12           ` Tom Rini
  0 siblings, 1 reply; 8+ messages in thread
From: Simon Glass @ 2023-02-01 20:20 UTC (permalink / raw)
  To: Heinrich Schuchardt; +Cc: Tom Rini, u-boot

Hi Heinrich,

On Sun, 29 Jan 2023 at 15:37, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
>
>
> On 1/28/23 23:01, Simon Glass wrote:
> > Hi Heinrich,
> >
> > On Thu, 26 Jan 2023 at 02:17, Heinrich Schuchardt
> > <heinrich.schuchardt@canonical.com> wrote:
> >>
> >> On 1/26/23 00:49, Simon Glass wrote:
> >>> Hi Heinrich,
> >>>
> >>> On Wed, 25 Jan 2023 at 12:00, Heinrich Schuchardt
> >>> <heinrich.schuchardt@canonical.com> wrote:
> >>>>
> >>>> This section does not match the standards of our documentation.
> >>>>
> >>>> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> >>>> ---
> >>>>    README | 74 ----------------------------------------------------------
> >>>>    1 file changed, 74 deletions(-)
> >>>>
> >>>
> >>> It seems fairly accurate to me, and includes some good advice.
> >>>
> >>> Regards,
> >>> Simon
> >>
> >> * That section tries to look funny. U-Boot is serious stuff.
> >
> > Some people do have a sense of humour...but in any case it might be
> > better to reword it to meet your standards, rather than delete it?
> >
> >> * The information is outdated. BDI3000 is not on sale,
> >> https://www.denx.de/wiki/bin/view/DULG/Manual is no longer maintained.
> >> * It contains advice that we would prefer not to give like
> >>     email("Hi, I am new to U-Boot, how do I get started?")
> >> * It is incomplete. You cannot introduce a new board without defconfig.
> >>
> >> An introduction chapter for new developers in doc/develop/ would be helpful.
> >
> > OK, so how about updating it, then? Having nothing at all seems bad to me.
>
> As Tom wrote README should be minimal and point to the HTML
> documentation. So nothing to update here. Are you able to provide a
> chapter on porting boards?

I was hoping you might, since you are wanting to remove what is there,
which I think is better than nothing.

Regards,
Simon

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/1] README: remove 'U-Boot Porting Guide' section
  2023-02-01 20:20         ` Simon Glass
@ 2023-02-02 16:12           ` Tom Rini
  0 siblings, 0 replies; 8+ messages in thread
From: Tom Rini @ 2023-02-02 16:12 UTC (permalink / raw)
  To: Simon Glass; +Cc: Heinrich Schuchardt, u-boot

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

On Wed, Feb 01, 2023 at 01:20:52PM -0700, Simon Glass wrote:
> Hi Heinrich,
> 
> On Sun, 29 Jan 2023 at 15:37, Heinrich Schuchardt
> <heinrich.schuchardt@canonical.com> wrote:
> >
> >
> >
> > On 1/28/23 23:01, Simon Glass wrote:
> > > Hi Heinrich,
> > >
> > > On Thu, 26 Jan 2023 at 02:17, Heinrich Schuchardt
> > > <heinrich.schuchardt@canonical.com> wrote:
> > >>
> > >> On 1/26/23 00:49, Simon Glass wrote:
> > >>> Hi Heinrich,
> > >>>
> > >>> On Wed, 25 Jan 2023 at 12:00, Heinrich Schuchardt
> > >>> <heinrich.schuchardt@canonical.com> wrote:
> > >>>>
> > >>>> This section does not match the standards of our documentation.
> > >>>>
> > >>>> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> > >>>> ---
> > >>>>    README | 74 ----------------------------------------------------------
> > >>>>    1 file changed, 74 deletions(-)
> > >>>>
> > >>>
> > >>> It seems fairly accurate to me, and includes some good advice.
> > >>>
> > >>> Regards,
> > >>> Simon
> > >>
> > >> * That section tries to look funny. U-Boot is serious stuff.
> > >
> > > Some people do have a sense of humour...but in any case it might be
> > > better to reword it to meet your standards, rather than delete it?
> > >
> > >> * The information is outdated. BDI3000 is not on sale,
> > >> https://www.denx.de/wiki/bin/view/DULG/Manual is no longer maintained.
> > >> * It contains advice that we would prefer not to give like
> > >>     email("Hi, I am new to U-Boot, how do I get started?")
> > >> * It is incomplete. You cannot introduce a new board without defconfig.
> > >>
> > >> An introduction chapter for new developers in doc/develop/ would be helpful.
> > >
> > > OK, so how about updating it, then? Having nothing at all seems bad to me.
> >
> > As Tom wrote README should be minimal and point to the HTML
> > documentation. So nothing to update here. Are you able to provide a
> > chapter on porting boards?
> 
> I was hoping you might, since you are wanting to remove what is there,
> which I think is better than nothing.

Having re-read the section that was removed, I agree with Heinrich here.
What was written 20 years ago, and still correct was too vague to be
useful.  Someone, anyone, writing something to put under doc/develop/
would be appreciated all the same.

-- 
Tom

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

^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2023-02-02 16:12 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-01-25 19:00 [PATCH 1/1] README: remove 'U-Boot Porting Guide' section Heinrich Schuchardt
2023-01-25 22:33 ` Tom Rini
2023-01-25 23:49 ` Simon Glass
2023-01-26  9:17   ` Heinrich Schuchardt
2023-01-28 22:01     ` Simon Glass
2023-01-29 22:37       ` Heinrich Schuchardt
2023-02-01 20:20         ` Simon Glass
2023-02-02 16:12           ` Tom Rini

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.