From f5dc64aa7ca1328887411d0201df2c2405ef2d58 Mon Sep 17 00:00:00 2001 From: Rhys Weatherley Date: Sun, 13 Mar 2016 07:24:22 +1000 Subject: [PATCH] Rename Terminal library to Shell library --- doc/Doxyfile | 2 +- doc/mainpage.dox | 2 +- doc/shell-serial.dox | 10 +++++----- doc/shell-telnet.dox | 2 +- libraries/{Terminal => Shell}/LoginShell.cpp | 0 libraries/{Terminal => Shell}/LoginShell.h | 0 libraries/{Terminal => Shell}/Shell.cpp | 0 libraries/{Terminal => Shell}/Shell.h | 0 libraries/{Terminal => Shell}/TelnetDefs.h | 0 libraries/{Terminal => Shell}/Terminal.cpp | 0 libraries/{Terminal => Shell}/Terminal.h | 0 libraries/{Terminal => Shell}/USBKeysExtra.h | 0 libraries/{Terminal => Shell}/examples/Keys/Keys.ino | 0 .../examples/SerialShell/SerialShell.ino | 0 .../examples/TelnetServer/TelnetServer.ino | 0 libraries/{Terminal => Shell}/keywords.txt | 0 16 files changed, 8 insertions(+), 8 deletions(-) rename libraries/{Terminal => Shell}/LoginShell.cpp (100%) rename libraries/{Terminal => Shell}/LoginShell.h (100%) rename libraries/{Terminal => Shell}/Shell.cpp (100%) rename libraries/{Terminal => Shell}/Shell.h (100%) rename libraries/{Terminal => Shell}/TelnetDefs.h (100%) rename libraries/{Terminal => Shell}/Terminal.cpp (100%) rename libraries/{Terminal => Shell}/Terminal.h (100%) rename libraries/{Terminal => Shell}/USBKeysExtra.h (100%) rename libraries/{Terminal => Shell}/examples/Keys/Keys.ino (100%) rename libraries/{Terminal => Shell}/examples/SerialShell/SerialShell.ino (100%) rename libraries/{Terminal => Shell}/examples/TelnetServer/TelnetServer.ino (100%) rename libraries/{Terminal => Shell}/keywords.txt (100%) diff --git a/doc/Doxyfile b/doc/Doxyfile index 35844dae..a2e1e445 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -666,7 +666,7 @@ INPUT = ../libraries/LCD \ ../libraries/Crypto \ ../libraries/RingOscillatorNoiseSource \ ../libraries/TransistorNoiseSource \ - ../libraries/Terminal \ + ../libraries/Shell \ . # This tag can be used to specify the character encoding of the source files diff --git a/doc/mainpage.dox b/doc/mainpage.dox index 836a5a65..c8ed795f 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -103,7 +103,7 @@ realtime clock and the LCD library to implement an alarm clock. More information can be found on the \ref crypto "Cryptographic Library" page. -\section main_Terminal Terminal Library +\section main_Shell Shell Library \li Terminal class that extends Stream with functions suitable for interfacing to a VT100-compatible terminal program like PuTTY. diff --git a/doc/shell-serial.dox b/doc/shell-serial.dox index 8fb08be2..a54e5fd7 100644 --- a/doc/shell-serial.dox +++ b/doc/shell-serial.dox @@ -32,14 +32,14 @@ the status LED on D13 on and off. We start by including the shell library definitions and declaring a variable of type Shell: -\dontinclude Terminal/examples/SerialShell/SerialShell.ino +\dontinclude Shell/examples/SerialShell/SerialShell.ino \skip #include \until Shell shell; Next we need to initialize the serial port and tell the shell object to use it for communications: -\dontinclude Terminal/examples/SerialShell/SerialShell.ino +\dontinclude Shell/examples/SerialShell/SerialShell.ino \skip void setup() \until } @@ -59,7 +59,7 @@ handle commands. We accomplish this by calling \link Shell::loop() shell.loop()\endlink from the application's main loop() function: -\dontinclude Terminal/examples/SerialShell/SerialShell.ino +\dontinclude Shell/examples/SerialShell/SerialShell.ino \skip void loop() \until } @@ -67,7 +67,7 @@ At this point the application will have two builtin commands, "help" and "exit". But we also want a command of our own. We do this by declaring a command handler: -\dontinclude Terminal/examples/SerialShell/SerialShell.ino +\dontinclude Shell/examples/SerialShell/SerialShell.ino \skip int ledPin \until ShellCommand @@ -76,5 +76,5 @@ help string, and the name of the handler function. The full source code for the example follows: -\include Terminal/examples/SerialShell/SerialShell.ino +\include Shell/examples/SerialShell/SerialShell.ino */ diff --git a/doc/shell-telnet.dox b/doc/shell-telnet.dox index 682b2726..ee3afe53 100644 --- a/doc/shell-telnet.dox +++ b/doc/shell-telnet.dox @@ -35,5 +35,5 @@ over the Internet via the telnet protocol. The example has one command The full source code for the example follows: -\include Terminal/examples/TelnetServer/TelnetServer.ino +\include Shell/examples/TelnetServer/TelnetServer.ino */ diff --git a/libraries/Terminal/LoginShell.cpp b/libraries/Shell/LoginShell.cpp similarity index 100% rename from libraries/Terminal/LoginShell.cpp rename to libraries/Shell/LoginShell.cpp diff --git a/libraries/Terminal/LoginShell.h b/libraries/Shell/LoginShell.h similarity index 100% rename from libraries/Terminal/LoginShell.h rename to libraries/Shell/LoginShell.h diff --git a/libraries/Terminal/Shell.cpp b/libraries/Shell/Shell.cpp similarity index 100% rename from libraries/Terminal/Shell.cpp rename to libraries/Shell/Shell.cpp diff --git a/libraries/Terminal/Shell.h b/libraries/Shell/Shell.h similarity index 100% rename from libraries/Terminal/Shell.h rename to libraries/Shell/Shell.h diff --git a/libraries/Terminal/TelnetDefs.h b/libraries/Shell/TelnetDefs.h similarity index 100% rename from libraries/Terminal/TelnetDefs.h rename to libraries/Shell/TelnetDefs.h diff --git a/libraries/Terminal/Terminal.cpp b/libraries/Shell/Terminal.cpp similarity index 100% rename from libraries/Terminal/Terminal.cpp rename to libraries/Shell/Terminal.cpp diff --git a/libraries/Terminal/Terminal.h b/libraries/Shell/Terminal.h similarity index 100% rename from libraries/Terminal/Terminal.h rename to libraries/Shell/Terminal.h diff --git a/libraries/Terminal/USBKeysExtra.h b/libraries/Shell/USBKeysExtra.h similarity index 100% rename from libraries/Terminal/USBKeysExtra.h rename to libraries/Shell/USBKeysExtra.h diff --git a/libraries/Terminal/examples/Keys/Keys.ino b/libraries/Shell/examples/Keys/Keys.ino similarity index 100% rename from libraries/Terminal/examples/Keys/Keys.ino rename to libraries/Shell/examples/Keys/Keys.ino diff --git a/libraries/Terminal/examples/SerialShell/SerialShell.ino b/libraries/Shell/examples/SerialShell/SerialShell.ino similarity index 100% rename from libraries/Terminal/examples/SerialShell/SerialShell.ino rename to libraries/Shell/examples/SerialShell/SerialShell.ino diff --git a/libraries/Terminal/examples/TelnetServer/TelnetServer.ino b/libraries/Shell/examples/TelnetServer/TelnetServer.ino similarity index 100% rename from libraries/Terminal/examples/TelnetServer/TelnetServer.ino rename to libraries/Shell/examples/TelnetServer/TelnetServer.ino diff --git a/libraries/Terminal/keywords.txt b/libraries/Shell/keywords.txt similarity index 100% rename from libraries/Terminal/keywords.txt rename to libraries/Shell/keywords.txt