From patchwork Tue Mar 22 00:56:22 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Bird, Tim" X-Patchwork-Id: 8636811 Return-Path: X-Original-To: patchwork-ltsi-dev@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 257619F294 for ; Tue, 22 Mar 2016 00:56:38 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 65FFD202E5 for ; Tue, 22 Mar 2016 00:56:37 +0000 (UTC) Received: from mail.linuxfoundation.org (mail.linuxfoundation.org [140.211.169.12]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 8C2ED202B8 for ; Tue, 22 Mar 2016 00:56:36 +0000 (UTC) Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 4E13771; Tue, 22 Mar 2016 00:56:36 +0000 (UTC) X-Original-To: ltsi-dev@lists.linuxfoundation.org Delivered-To: ltsi-dev@mail.linuxfoundation.org Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id 6C7BE71 for ; Tue, 22 Mar 2016 00:56:35 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from SELDSEGREL01.sonyericsson.com (seldsegrel01.sonyericsson.com [37.139.156.29]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id 5A44FEB for ; Tue, 22 Mar 2016 00:56:34 +0000 (UTC) To: "ltsi-dev@lists.linuxfoundation.org" , Dmitry Cherkasov From: Tim Bird Message-ID: <56F09836.1070401@sonymobile.com> Date: Mon, 21 Mar 2016 17:56:22 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101 Thunderbird/38.6.0 MIME-Version: 1.0 X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org Cc: Artemi Ivanov Subject: [LTSI-dev] [PATCH] Clean up README X-BeenThere: ltsi-dev@lists.linuxfoundation.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: "A list to discuss patches, development, and other things related to the LTSI project" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: ltsi-dev-bounces@lists.linuxfoundation.org Errors-To: ltsi-dev-bounces@lists.linuxfoundation.org X-Virus-Scanned: ClamAV using ClamSMTP Add articles ('the's and 'an's). Reword a few places. Keep lines under 80 columns. Add some stuff about the container shell. --- This is a simple patch to fix a few cosmetic issues with the README. README | 46 +++++++++++++++++++++++++++++----------------- 1 file changed, 29 insertions(+), 17 deletions(-) diff --git a/README b/README index 32a6f2f..f983cc6 100644 --- a/README +++ b/README @@ -1,36 +1,48 @@ Fuego ======================= -Installing Fuego to docker container --------------------------------------------------------------------------------- -Run install.sh from top directory. This will launch ``docker build'' command. -Please modify Dockerfile to suit your needs. +Installing Fuego to a docker container +------------------------------------------------------------------------------- +Run install.sh from the top directory. This will launch the ``docker build'' +command. You can modify the Dockerfile to suit your needs. Running --------------------------------------------------------------------------------- -Issue the following commands from top directory: +------------------------------------------------------------------------------- +Issue the following commands from the top directory: -fuego-host-scripts/docker-create-container.sh -fuego-host-scripts/docker-start-container.sh + fuego-host-scripts/docker-create-container.sh + fuego-host-scripts/docker-start-container.sh -Web interface will be available at http://localhost:8080/fuego +Once the container is started, a web interface to the test system will +be available at: http://localhost:8080/fuego + +The shell used to start the container will enter a shell inside the +container. If you exit that shell, the container will stop, and you +will be returned to the host shell. Configuration --------------------------------------------------------------------------------- -Please see manual (docs/fuego-docs.pdf) for configuration and using. +------------------------------------------------------------------------------- +Please see the manual (docs/fuego-docs.pdf) for configuration and usage. -docker-create-containter.sh configures Docker to use host network (--net="host" option). -Please see Docker manual for different network setup. +docker-create-containter.sh configures Docker to use the host network +(using the --net="host" option). +Please see the Docker manual for different network setup options. -Container is configured to run ssh server at 2222 port. Modify container-cfg/sshd_config file if you need to configure ssh server differently. +The container is configured to run an ssh server at 2222 port. Modify either +the file container-cfg or or the file sshd_config if you need to configure +the ssh server differently. Updating --------------------------------------------------------------------------------- -While inside docker container go to /home/jenkins/fuego and issue ``git pull''. +------------------------------------------------------------------------------- +While inside the docker container go to /home/jenkins/fuego and issue +``git pull''. + This will update the following components: - Fuego engine - tests - overlays - jenkins jobs -Boards configuration, toolchain setup and Jenkins' config.xml will not be touched since these are located in external docker volume that is mounted to /userdata inside container. +Board configurations, toolchain setup and Jenkins' config.xml will not be +touched since these are located in an external docker volume that is +mounted at /userdata inside container.