From 2b8e5854fb88dd9870441f3310bb5a837c34b41a Mon Sep 17 00:00:00 2001 From: Nathan Pemberton Date: Tue, 25 Jun 2019 12:56:19 -0400 Subject: [PATCH 1/4] Update readme for 1.6 release --- README.md | 33 ++++++++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 33796957..c1b0e0fe 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,32 @@ https://docs.fires.im/en/latest/Advanced-Usage/FireMarshal/index.html You can also find the latest FireSim source at: https://github.com/firesim/firesim -## Requirements -This project was written for python 3.4 +# Requirements +The easiest way to use Marshal is to run it via firesim on Amazon EC2 by +following the instructions at https://docs.fires.im/en/latest/. However, this +is not required. To run Firemarshal independently, you will need the following +dependencies: -python-requirements.txt and centos-requirements.txt are incomplete lists of -required packages for python3. If you find that you need a package not in those -lists, please file an issue. +## Standard Packages +centos-requirements.txt is a list of packages for centos7 that are needed by marshal. You can install these with: +``` +cat centos-requirements.txt | sudo xargs yum install -y +``` + +Package names may be different on other distributions. + +### Note for Ubuntu +The libguestfs-tools package (needed for the guestmount command) does not work +out of the box on Ubuntu. See +https://github.com/firesim/firesim-software/issues/30 for a workaround. + +## Python +This project was written for python 3.6. You can install all dependencies using: +``` +pip3 install python-requirements.txt +``` + +## riscv-tools +In addition to standard libraries, you will need riscv-tools +(https://github.com/firesim/riscv-tools.git). This was last tested with commit +bce7b5e (gcc version 7.2). From 691c77fe1f0cc8de2dcb1a16dd6246f8375131d0 Mon Sep 17 00:00:00 2001 From: Nathan Pemberton Date: Tue, 25 Jun 2019 13:04:22 -0400 Subject: [PATCH 2/4] Add version number --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c1b0e0fe..b81f2add 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ FireMarshal (firesim-software) +Version 1.6 ================================== This tool builds base images for several linux-based distros that work with qemu, @@ -18,7 +19,8 @@ is not required. To run Firemarshal independently, you will need the following dependencies: ## Standard Packages -centos-requirements.txt is a list of packages for centos7 that are needed by marshal. You can install these with: +centos-requirements.txt is a list of packages for centos7 that are needed by +marshal. You can install these with: ``` cat centos-requirements.txt | sudo xargs yum install -y ``` From 9c0cd5e28f9f056209182adb531ed4785878d993 Mon Sep 17 00:00:00 2001 From: Nathan Pemberton Date: Tue, 25 Jun 2019 13:08:19 -0400 Subject: [PATCH 3/4] Adds changelog --- CHANGELOG.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..bb3352bb --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,21 @@ +# Changelog + +This changelog follows the format defined here: https://keepachangelog.com/en/1.0.0/ + +## [1.6.0] - 2019-06-25 +This release introduces a number of bug-fixes and support for standalone behavior (marshal can now be cloned by itself on a machine without sudo). It also synchronizes with firesim release 1.6. + +### Added +* PR #31 allows firesim-software to work outside of a firesim environment without the need for sudo (just riscv-tools, qemu, and a few package requirements). +* PR #24 adds support for parallel 'launch' or 'test' commands. + +### Changed +* PR #25 updates buildroot to a more recent version in order to support a more recent version of riscv-tools (as needed by firesim). + * PR #32 finalizes the riscv-tools at gcc 7.2 +* PR #22 enables multiple repository mirrors in the default fedora image + +### Fixed +* PR #34 resolves #33 +* PR #29 fixes a number of issues with the full_test.sh script (bug #26 ) +* PR #28 fixes an incompatibility with python36 + * Note that #31 officially updated the python version to 3.6, but firesim de-facto updated it in an earlier release. From 7fc107185d00058ccb6b1d69032a8985be1de322 Mon Sep 17 00:00:00 2001 From: Nathan Pemberton Date: Tue, 25 Jun 2019 13:12:11 -0400 Subject: [PATCH 4/4] Add license --- LICENSE | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..17db754a --- /dev/null +++ b/LICENSE @@ -0,0 +1,24 @@ +Copyright (c) 2017-2019, The Regents of the University of California +(Regents). All Rights Reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. +3. Neither the name of the Regents nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. + +IN NO EVENT SHALL REGENTS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, +SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING +OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF REGENTS HAS +BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +REGENTS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED +HEREUNDER IS PROVIDED "AS IS". REGENTS HAS NO OBLIGATION TO PROVIDE +MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.