From patchwork Thu Oct 11 03:24:14 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andy Doan X-Patchwork-Id: 12161 Return-Path: X-Original-To: patchwork@peony.canonical.com Delivered-To: patchwork@peony.canonical.com Received: from fiordland.canonical.com (fiordland.canonical.com [91.189.94.145]) by peony.canonical.com (Postfix) with ESMTP id 443C224188 for ; Thu, 11 Oct 2012 03:24:18 +0000 (UTC) Received: from mail-ia0-f180.google.com (mail-ia0-f180.google.com [209.85.210.180]) by fiordland.canonical.com (Postfix) with ESMTP id C6D55A181EA for ; Thu, 11 Oct 2012 03:24:17 +0000 (UTC) Received: by mail-ia0-f180.google.com with SMTP id f6so909252iag.11 for ; Wed, 10 Oct 2012 20:24:17 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=x-forwarded-to:x-forwarded-for:delivered-to:received-spf :content-type:mime-version:x-launchpad-project:x-launchpad-branch :x-launchpad-message-rationale:x-launchpad-branch-revision-number :x-launchpad-notification-type:to:from:subject:message-id:date :reply-to:sender:errors-to:precedence:x-generated-by :x-launchpad-hash:x-gm-message-state; bh=0RsBKimJ/L8UUl3wNXIuYqZG0ElEeSVJqtaAlL0o8oE=; b=VLQ8S5gTW+1S82xpZ+4uGH1e2FghZxIWGscxGIFRtoQMYo0zionQbNgsgFMN3/IssC RgOaZEvxBMIdvPd8OIas1Bi7DqFcqz8XBvcqkUwqL8flebul7ldcGyM1BWI1dTw7VMb1 MZQx3PNda18qtM6b++CSiBmc+x+eATqL5ROrxTJfWnteRF+mEwNhWQVgjmg++/TszR9F V31nNR2RvcVlB7XbYbG8Ze3ixva9Gcw3p88TlXIZ/02TCoo386CIR7tqZYG8+pUNIoeX KszeTQTvMXlHSP22186zWUkxW5QodG4Qea6bIJVVgOA1sJzSUppv3iUtzDYVQNUz0OLY WJwg== Received: by 10.42.57.10 with SMTP id b10mr15917011ich.54.1349925857143; Wed, 10 Oct 2012 20:24:17 -0700 (PDT) X-Forwarded-To: linaro-patchwork@canonical.com X-Forwarded-For: patch@linaro.org linaro-patchwork@canonical.com Delivered-To: patches@linaro.org Received: by 10.50.67.148 with SMTP id n20csp333280igt; Wed, 10 Oct 2012 20:24:16 -0700 (PDT) Received: by 10.216.134.168 with SMTP id s40mr9201594wei.158.1349925855463; Wed, 10 Oct 2012 20:24:15 -0700 (PDT) Received: from indium.canonical.com (indium.canonical.com. [91.189.90.7]) by mx.google.com with ESMTPS id t19si3843840wen.58.2012.10.10.20.24.14 (version=TLSv1/SSLv3 cipher=OTHER); Wed, 10 Oct 2012 20:24:15 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of bounces@canonical.com designates 91.189.90.7 as permitted sender) client-ip=91.189.90.7; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of bounces@canonical.com designates 91.189.90.7 as permitted sender) smtp.mail=bounces@canonical.com Received: from ackee.canonical.com ([91.189.89.26]) by indium.canonical.com with esmtp (Exim 4.71 #1 (Debian)) id 1TM9Ne-0001fy-Oj for ; Thu, 11 Oct 2012 03:24:14 +0000 Received: from ackee.canonical.com (localhost [127.0.0.1]) by ackee.canonical.com (Postfix) with ESMTP id AA488E03B8 for ; Thu, 11 Oct 2012 03:24:14 +0000 (UTC) MIME-Version: 1.0 X-Launchpad-Project: lava-dispatcher X-Launchpad-Branch: ~linaro-validation/lava-dispatcher/trunk X-Launchpad-Message-Rationale: Subscriber X-Launchpad-Branch-Revision-Number: 399 X-Launchpad-Notification-Type: branch-revision To: Linaro Patch Tracker From: noreply@launchpad.net Subject: [Branch ~linaro-validation/lava-dispatcher/trunk] Rev 399: more documentation updates Message-Id: <20121011032414.16166.17506.launchpad@ackee.canonical.com> Date: Thu, 11 Oct 2012 03:24:14 -0000 Reply-To: noreply@launchpad.net Sender: bounces@canonical.com Errors-To: bounces@canonical.com Precedence: bulk X-Generated-By: Launchpad (canonical.com); Revision="16118"; Instance="launchpad-lazr.conf" X-Launchpad-Hash: ca112df6a8ed3a48c588a811d028ae2321442773 X-Gm-Message-State: ALoCoQkcw7f8L/IPSff/NCKuQdxm4ByFuz0AKIGe3ZDD37LjJC59etAbP8bOUOw4woCdaDqYBqxT Merge authors: Andy Doan (doanac) ------------------------------------------------------------ revno: 399 [merge] committer: Andy Doan branch nick: upstream timestamp: Wed 2012-10-10 22:22:41 -0500 message: more documentation updates removed: doc/code.rst doc/todo.rst kind changed: doc/configuration.rst (file => symlink) modified: doc/index.rst doc/usage.rst lava_dispatcher/default-config/lava-dispatcher/README --- lp:lava-dispatcher https://code.launchpad.net/~linaro-validation/lava-dispatcher/trunk You are subscribed to branch lp:lava-dispatcher. To unsubscribe from this branch go to https://code.launchpad.net/~linaro-validation/lava-dispatcher/trunk/+edit-subscription === removed file 'doc/code.rst' --- doc/code.rst 2011-12-22 06:11:18 +0000 +++ doc/code.rst 1970-01-01 00:00:00 +0000 @@ -1,12 +0,0 @@ - -Code Documentation -****************** - -.. automodule:: lava_dispatcher - :members: - -.. automodule:: lava_dispatcher.client.base - :members: - -.. automodule:: lava_dispatcher.client.master - :members: === modified file 'doc/configuration.rst' --- doc/configuration.rst 2012-04-26 03:32:35 +0000 +++ doc/configuration.rst 1970-01-01 00:00:00 +0000 @@ -1,18 +0,0 @@ -.. _configuration: - -Configuration -============= - -Guideline -^^^^^^^^^ - -Please refer to README in lava-dispatcher source code:: - - lava-dispatcher/lava_dispatcher/default-config/lava-dispatcher/README - -Or browse on the `web page `_ - -Don't forget to setup LAVA_SERVER_IP, and LAVA_PROXY if there is one proxy, -which will prompt the performance explicitly. - -You can set up a squid service, refer to :ref:`proxy` === target is u'../lava_dispatcher/default-config/lava-dispatcher/README' === modified file 'doc/index.rst' --- doc/index.rst 2012-10-10 19:29:04 +0000 +++ doc/index.rst 2012-10-11 02:51:21 +0000 @@ -8,24 +8,10 @@ boards in validation farm, and publish the test result back to dashboard. It is scheduled by validation scheduler, and it could also run as standalone. -.. seealso:: To learn more about LAVA see https://launchpad.net/lava - - -Features -======== - -* Ability to accept, parse and run a job which consists of different actions - and test cases, then upload test result to LAVA Dashboard on an ARM target - system. -* Support ARM target boards including Beagle, Panda, i.MX51 EVK, i.MX53 - QuickStart, Snowball, Origen, Versatile Express, Fast Models, and QEMU. -* Support Android system on Panda, i.MX53 QuickStart board, Snowball, Origen, - Versatile Express, and Fast Models. -* Support for local user-defined configuration data for boards, device types. -* Extensible device types and boards configuration editing, can add new device - and new board. -* Make use of the output of LAVA test, which is Linaro Dashboard Bundle format, - upload test results to the LAVA Dashboard for result archiving and analysis. +You can see an up-to-date list of supported target devices by looking at the +`device types`_ in Launchpad. + +.. _device types: http://bazaar.launchpad.net/~linaro-validation/lava-dispatcher/trunk/files/head:/lava_dispatcher/default-config/lava-dispatcher/device-types Installation ============ @@ -37,12 +23,30 @@ .. _main project page: http://lava.readthedocs.org/en/latest/ .. _stand-alone development and testing: standalonesetup.html +Indices and tables +================== + +.. toctree:: + :maxdepth: 2 + + standalonesetup.rst + configuration.rst + jobfile.rst + usage.rst + proxy.rst + +* :ref:`search` + Source code, bugs and patches ============================= The project is maintained on Launchpad at http://launchpad.net/lava-dispatcher/. +We maintain an online log of `release notes`_ + +.. _release notes: changes.html + You can get the source code with bazaar using ``bzr branch lp:lava-dispatcher``. Patches can be submitted using Launchpad merge proposals (for introduction to this and topic see @@ -53,22 +57,4 @@ Most of the team is usually available in ``#linaro`` on ``irc.freenode.net``. Feel free to drop by to chat and ask questions. -Indices and tables -================== - -.. toctree:: - :maxdepth: 2 - - standalonesetup.rst - configuration.rst - proxy.rst - jobfile.rst - usage.rst - changes.rst - code.rst - todo.rst - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` === removed file 'doc/todo.rst' --- doc/todo.rst 2011-10-09 09:46:11 +0000 +++ doc/todo.rst 1970-01-01 00:00:00 +0000 @@ -1,4 +0,0 @@ -List of items that need work -============================ - -.. todolist:: === modified file 'doc/usage.rst' --- doc/usage.rst 2011-10-09 09:46:11 +0000 +++ doc/usage.rst 2012-10-11 03:22:08 +0000 @@ -19,46 +19,15 @@ job file that are to be executed and then executes them manually (by manually running LAVA Dispatcher, the actual execution process are non-interactive). -Typically this mode is based on the following sequence of commands: - -#. Install lava-dispatcher (from PPA or source) along with the required dependencies on LAVA Server. -#. Configure local or remote development boards and device types. -#. Add or edit job files which are to be executed. -#. Execute dispatcher manually: $ sudo lava-dispatch ./lava-ltp-job.json - -At last dispatcher will publish the test results to LAVA Dashboard. +Follow the `Quick Developer Setup`_ instructions to get started. + +.. _Quick Developer Setup: standalonesetup.html Usage with the LAVA Scheduler ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The scheduler is useful for automating LAVA Dispatcher environment setup, describing test scenarios (the list of tests to invoke) and finally storing the results in the LAVA dashboard. -Typically this mode is based on the following sequence of commands: - -#. Install lava-dispatcher (from PPA or source) along with the required dependencies on LAVA Server. -#. Configure local or remote development boards and device types. -#. Add or edit job files which are to be executed. -#. Configure LAVA Scheduler to execute job files. - -Debug -^^^^^ - -Debug - -.. todo:: - - Describe how to collect enough information to debug dispatcher when the job execution failed. - -Check test result on LAVA Dashboard -=================================== - -.. todo:: - - Describe how to view test results on dashboard. - -Debug with serial log -============================== - -.. todo:: - - Describe the information including logging information/warning and exception information. +This scenario can be configured by following our `deployment instructions`_ + +.. _deployment instructions: http://lava.readthedocs.org/en/latest/ === modified file 'lava_dispatcher/default-config/lava-dispatcher/README' --- lava_dispatcher/default-config/lava-dispatcher/README 2012-04-10 10:56:09 +0000 +++ lava_dispatcher/default-config/lava-dispatcher/README 2012-10-11 02:51:21 +0000 @@ -10,6 +10,9 @@ * ~/.config/lava-dispatcher for user settings. + * /srv/lava//etc/lava-dispatcher for deployments done using + lava-deployment-tool + Each config directory can contain two files and two directories: * lava-dispatcher.conf