prettier: re-format
Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.
Change-Id: I81cb995cc3c633d3c8fdc8cc109e9f0afec01ec5
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
diff --git a/.travis.yml b/.travis.yml
index c58cbf6..5954fe0 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -4,17 +4,18 @@
dist: trusty
compiler:
- - clang
- - gcc
+ - clang
+ - gcc
install:
- - sudo apt-add-repository -y ppa:ubuntu-toolchain-r/test
- - sudo apt-add-repository -y ppa:h-rayflood/llvm
- - sudo apt-get update && sudo apt-get install -yy gcc-5 clang-3.6
- - sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-5 50
- - sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-3.6 50
- - gcc --version
- - clang --version
+ - sudo apt-add-repository -y ppa:ubuntu-toolchain-r/test
+ - sudo apt-add-repository -y ppa:h-rayflood/llvm
+ - sudo apt-get update && sudo apt-get install -yy gcc-5 clang-3.6
+ - sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-5 50
+ - sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-3.6
+ 50
+ - gcc --version
+ - clang --version
script:
- - autoreconf -i && ./configure && make
+ - autoreconf -i && ./configure && make
diff --git a/README.md b/README.md
index 3abb9b6..2b4e98d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
## To Build
-Note: In addition to a toolchain and autoconf tools, this requires `autotools-archive` to be installed.
+
+Note: In addition to a toolchain and autoconf tools, this requires
+`autotools-archive` to be installed.
To build this project, run the following shell commands:
@@ -10,11 +12,13 @@
```
To fully clean the repository, run:
+
```
./bootstrap.sh clean
```
## To Run Server
+
Running the server requires a serial port (e.g. /dev/ttyS0):
```
@@ -23,6 +27,7 @@
```
## To Connect Client
+
To connect to the server, simply run the client:
```
@@ -31,7 +36,6 @@
To disconnect the client, use the standard `~.` combination.
-
## Underlying design
This shows how the host UART connection is abstracted within the BMC as a Unix
@@ -55,8 +59,8 @@
+--------------------------------------------------------------------------------------------+
```
-This supports multiple independent consoles. The socket-id is a unique
-portion for the unix domain socket created by the obmc-console-server
-instance. The server needs to know this because it needs to know what to name
-the pipe; the client needs to know it as it needs to form the abstract socket
-name to which to connect.
+This supports multiple independent consoles. The socket-id is a unique portion
+for the unix domain socket created by the obmc-console-server instance. The
+server needs to know this because it needs to know what to name the pipe; the
+client needs to know it as it needs to form the abstract socket name to which to
+connect.