summaryrefslogtreecommitdiff
path: root/util/ec3po
diff options
context:
space:
mode:
authorAseda Aboagye <aaboagye@google.com>2015-12-01 14:00:38 -0800
committerchrome-bot <chrome-bot@chromium.org>2015-12-08 20:05:05 -0800
commitf5773e74d536f8c5350c96fcfbe8b8e6ce0009da (patch)
treea4af12da77b209fc6d9adeab22ab221af8df3a45 /util/ec3po
parentc665d557cb3297fa95824ccd8549dd98541b3b80 (diff)
downloadchrome-ec-f5773e74d536f8c5350c96fcfbe8b8e6ce0009da.tar.gz
ec3po: Add setup script.
This commit adds a setup script for the ec3po package. This is necessary such that ec3po can be included as a part of ec-devutils. BUG=chrome-os-partner:46054 BRANCH=None TEST=Update the ec-devutils ebuild to install the ec3po package. sudo emerge ec-devutils; `python -c 'import ec3po'; print ec3po` in the chroot. Verify that ec3po is installed in the site-packages. TEST=Verify that interpreter and console modules are exported in the package. CQ-DEPEND=CL:316479 Change-Id: I5c8856b530936dc4ce3b09e38802f1e015c4576b Signed-off-by: Aseda Aboagye <aaboagye@google.com> Reviewed-on: https://chromium-review.googlesource.com/316701 Commit-Ready: Aseda Aboagye <aaboagye@chromium.org> Tested-by: Aseda Aboagye <aaboagye@chromium.org> Reviewed-by: Randall Spangler <rspangler@chromium.org> Reviewed-by: Mike Frysinger <vapier@chromium.org>
Diffstat (limited to 'util/ec3po')
-rw-r--r--util/ec3po/__init__.py24
1 files changed, 24 insertions, 0 deletions
diff --git a/util/ec3po/__init__.py b/util/ec3po/__init__.py
index e69de29bb2..e40e417b98 100644
--- a/util/ec3po/__init__.py
+++ b/util/ec3po/__init__.py
@@ -0,0 +1,24 @@
+# Copyright 2015 The Chromium OS Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+"""The EC console interpreter.
+
+EC-3PO is a console interpreter which migrates the rich debug console from the
+EC itself to the host. This allows for a rich debug console without impacting
+EC image sizes while also allowing the development of new console features.
+
+The package consists of two modules: console and interpreter. The console
+module provides the interactive console interface between the user and the
+interpreter. It handles the presentation of the EC console including editing
+methods as well as session-persistent command history.
+
+The interpreter module provides the interpretation layer between the EC UART and
+the user. The user does not necessarily have to be the interactive console, but
+could be something like autotest. The interpreter is also responsible for the
+automatic command retrying if the EC drops a character in a command. This is a
+stopgap until all commands are communicated via host commands.
+"""
+
+import console
+import interpreter