[U-Boot] [PATCH] README: Add handy kermit primer
README: Add handy kermit primer
Signed-off-by: Karl O. Pinc kop@meme.com --- Add handy primer on using C-Kermit to the README to make kermit juicyer for minicom users.
I don't know if you really want this. It does seem a bit offtopic. But I need to look at this every time I start kermit so thought it might be handy to have in the README.
README | 16 +++++++++++++++- 1 files changed, 15 insertions(+), 1 deletions(-)
diff --git a/README b/README index 6bb5992..ad4e8fb 100644 --- a/README +++ b/README @@ -4633,7 +4633,21 @@ Unix, I recommend to use C-Kermit for general purpose use (and especially for kermit binary protocol download ("loadb" command), and use "cu" for S-Record download ("loads" command).
-Nevertheless, if you absolutely want to use it try adding this +A typical C-Kermit session looks like: + +$ kermit ;# Start kermit from Unix shell +set modem type none ; null modem cable to device +set line /dev/ttyUSB0 ; change tty per your hardware +set flow /direct-serial ; turn off flow control +set speed 115200 ; change to your baud rate +set carrier-watch off ; needed when no CTS pin +show communications ; review result +connect ; talk to device +<talk to device> +Ctrl-\C ; exit back to kermit +exit ; exit kermit + +Nevertheless, if you absolutely want to use minicom try adding this configuration to your "File transfer protocols" section:
Name Program Name U/D FullScr IO-Red. Multi
Dear "Karl O. Pinc",
In message 1344010828-1548-1-git-send-email-kop@meme.com you wrote:
README: Add handy kermit primer
Signed-off-by: Karl O. Pinc kop@meme.com
Add handy primer on using C-Kermit to the README to make kermit juicyer for minicom users.
Thanks - but pleasemove this into a separate file in the doc/ directory (and consider updating the wiki, too).
+A typical C-Kermit session looks like:
+$ kermit ;# Start kermit from Unix shell +set modem type none ; null modem cable to device +set line /dev/ttyUSB0 ; change tty per your hardware +set flow /direct-serial ; turn off flow control
Does this really turn off low control?
I use this instead:
set flow-control none
+Ctrl-\C ; exit back to kermit +exit ; exit kermit
These could be combined into Ctrl-\q
See also http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. which contains a few more settings useful if you try using file transfers.
Best regards,
Wolfgang Denk
Add doc/README.kermit.
Mention in README.
Signed-off-by: Karl O. Pinc kop@meme.com --- Thanks for the guidance.
Turns out the wiki has an even better guide. (It does not mention entering commands interactively. Oh well.)
P.S. I'm not sure I'm threading this right. I'm threading to the original patch submission, not your reply. Is that right?
Changes to v2: - Get rid of primer in README. - Add doc/README.kermit, as copy of wiki kermit setup docs - Reference doc/README.kermit in README.
README | 2 +- doc/README.kermit | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 1 deletions(-) create mode 100644 doc/README.kermit
diff --git a/README b/README index 6bb5992..f9535de 100644 --- a/README +++ b/README @@ -4631,7 +4631,7 @@ Over time, many people have reported problems when trying to use the consider minicom to be broken, and recommend not to use it. Under Unix, I recommend to use C-Kermit for general purpose use (and especially for kermit binary protocol download ("loadb" command), and -use "cu" for S-Record download ("loads" command). +use "cu" for S-Record download ("loads" command). See doc/README.kermit.
Nevertheless, if you absolutely want to use it try adding this configuration to your "File transfer protocols" section: diff --git a/doc/README.kermit b/doc/README.kermit new file mode 100644 index 0000000..f103d6a --- /dev/null +++ b/doc/README.kermit @@ -0,0 +1,52 @@ +Copied from the U-Boot wiki, +http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. +on 2012-08-03. + +4.3. Configuring the "kermit" command + +The name kermit stands for a whole family of communications software +for serial and network connections. The fact that it is available for +most computers and operating systems makes it especially well suited +for our purposes. + +kermit executes the commands in its initialization file, .kermrc, in +your home directory before it executes any other commands, so this can +be easily used to customize its behaviour using appropriate +initialization commands. The following settings are recommended for +use with U-Boot and Linux: + + * ~/.kermrc: + +set line /dev/ttyS0 +set speed 115200 +set carrier-watch off +set handshake none +set flow-control none +robust +set file type bin +set file name lit +set rec pack 1000 +set send pack 1000 +set window 5 + +This example assumes that you use the first serial port of your host +system (/dev/ttyS0) at a baudrate of 115200 to connect to the target's +serial console port. + +You can then connect to the serial line: + +$ kermit -c +Connecting to /dev/ttyS0, speed 115200. +The escape character is Ctrl-\ (ASCII 28, FS) +Type the escape character followed by C to get back, +or followed by ? to see other options. +---------------------------------------------------- + +TIP Due to licensing conditions you will often find two kermit +packages in your GNU/Linux distribution. In this case you will want to +install the ckermit package. The gkermit package is only a command +line tool implementing the kermit transfer protocol. + +TIP If you cannot find kermit on the distribution media for your Linux +host system, you can download it from the kermit project home page: +http://www.columbia.edu/kermit/
Dear "Karl O. Pinc",
In message 1344017124-5749-1-git-send-email-kop@meme.com you wrote:
Add doc/README.kermit.
Mention in README.
Signed-off-by: Karl O. Pinc kop@meme.com
...
--- a/README +++ b/README @@ -4631,7 +4631,7 @@ Over time, many people have reported problems when trying to use the consider minicom to be broken, and recommend not to use it. Under Unix, I recommend to use C-Kermit for general purpose use (and especially for kermit binary protocol download ("loadb" command), and -use "cu" for S-Record download ("loads" command). +use "cu" for S-Record download ("loads" command). See doc/README.kermit.
Instead of adding a new file, place the URL to the wiki page here.
--- /dev/null +++ b/doc/README.kermit @@ -0,0 +1,52 @@ +Copied from the U-Boot wiki, +http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. +on 2012-08-03.
This makes no sense to me. Copying the text just means we have to maintain the same information in two places, which never works.
Instead of copying the data, just add a link to the README.
Best regards,
Wolfgang Denk
Signed-off-by: Karl O. Pinc kop@meme.com --- README | 5 ++++- 1 files changed, 4 insertions(+), 1 deletions(-)
********* On 09/02/2012 10:47:45 AM, Wolfgang Denk wrote:
In message 1344017124-5749-1-git-send-email-kop@meme.com you wrote:
Add doc/README.kermit.
Mention in README.
doc/README.kermit.
Instead of adding a new file, place the URL to the wiki page here.
Ok. Done.
--- /dev/null +++ b/doc/README.kermit @@ -0,0 +1,52 @@ +Copied from the U-Boot wiki, +http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. +on 2012-08-03.
This makes no sense to me. Copying the text just means we have to maintain the same information in two places, which never works.
My thought was that no matter _what_ you do you have to maintain the same information in two places -- the wiki url is subject to change and any files in the source distribution will have to be updated as the url changes. Since we have to periodically bring the source distribution in line with the wiki anyway, may as well copy the relvent text as well. It's hardly any more work to keep up to date and at least the person with the source will always have something, presumably more useful that an outdated url, at hand. The wiki text will change more rapidly than the url; my thought was that the current text will remain useful regardless and if the url is referenced there's always the option of getting something more current.
diff --git a/README b/README index af76b0c..754e75a 100644 --- a/README +++ b/README @@ -4688,7 +4688,10 @@ Over time, many people have reported problems when trying to use the consider minicom to be broken, and recommend not to use it. Under Unix, I recommend to use C-Kermit for general purpose use (and especially for kermit binary protocol download ("loadb" command), and -use "cu" for S-Record download ("loads" command). +use "cu" for S-Record download ("loads" command). See +http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. +for help with kermit. +
Nevertheless, if you absolutely want to use it try adding this configuration to your "File transfer protocols" section:
On Mon, Oct 01, 2012 at 05:11:56AM -0000, Karl O. Pinc wrote:
Signed-off-by: Karl O. Pinc kop@meme.com
README | 5 ++++- 1 files changed, 4 insertions(+), 1 deletions(-)
Applied to u-boot/master, thanks!
participants (3)
-
Karl O. Pinc -
Tom Rini -
Wolfgang Denk