[PATCH 1/1] README: remove 'U-Boot Porting Guide' section
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 ============
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
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
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
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
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
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
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.
participants (3)
-
Heinrich Schuchardt -
Simon Glass -
Tom Rini