aboutsummaryrefslogtreecommitdiffstats
path: root/images/README.md
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2018-05-17 14:09:47 -0700
committerMartin Braun <martin.braun@ettus.com>2018-05-17 14:09:47 -0700
commit174bde6cc17c901b116c99fea8f1888c96f7823b (patch)
tree5d5df5385ece52acceb9763ae50ebacc57d0d719 /images/README.md
parent9591c93dd53f95b845ceead39eaaf219dc18659b (diff)
downloaduhd-174bde6cc17c901b116c99fea8f1888c96f7823b.tar.gz
uhd-174bde6cc17c901b116c99fea8f1888c96f7823b.tar.bz2
uhd-174bde6cc17c901b116c99fea8f1888c96f7823b.zip
images: Update scripts for new release model
- populate_images.py: Made Py3k safe - uhdimgs.py: Make Py3k-safe - create_imgs_package.py: Rewrote to build release images packages - make_zip.sh: Skip CMake, just zip up the files - Updated README to reflect all the changes
Diffstat (limited to 'images/README.md')
-rw-r--r--images/README.md83
1 files changed, 10 insertions, 73 deletions
diff --git a/images/README.md b/images/README.md
index 6c96fde7b..f9ffeb667 100644
--- a/images/README.md
+++ b/images/README.md
@@ -1,83 +1,20 @@
UHD Firmware and FPGA Images Builder
===============================================================
-The images directory contains the following:
-* A Makefile for building firmware and FPGA images
-* Scripts to load all the binaries for this current commit, as
- well as create a new images package from the images in subdir
- images/
+The images directory is an aid to prepare images packages.
-This provides a clean and organized way to build all of the firmware and FPGA
-images, the source code for which is in the `firmware` and `fpga` directories
-one level above this, and also maintains a linkage between images and git commits.
+Building the actual FPGA images is not handled with these tools.
-Building the binaries
----------------------
+## Making image packages
-The Makefile and build systems for the images are *probably* Unix-specific.
-It's best to build the images on a Unix system with standard build tools. The
-CMake package target will create an installable images package for your system.
+At any point in time, when the FPGA images change, you will need to create new
+FPGA images packages. Use the `package_images.py` script for that purpose.
-__To build the images (unix):__
+## Create image tarballs for releases
-1. `make clean`
-2. `make images`
+If you're on a release tag and want to create images packages for uploading to
+github, run
-__Fedora note:__
-
-The sdcc binaries are prefixed with "sdcc-" which breaks the build.
-However, /usr/libexec/sdcc contains properly named sdcc binaries.
-`export PATH=${PATH}:/usr/libexec/sdcc`
-
-
-Updating binaries
------------------
-
-This goes two ways:
-
-1. Loading the correct binaries for this commit
-2. Updating the binary package on this branch
-
-
-### Loading the correct binaries ###
-
-If you check out a branch or commit, you might want to use the exact same
-binaries that were used when this branch or commit was generated.
-To do this, run `populate_images.py`. This will either download the correct
-images package from a web server or from a local directory if
-`UHD_IMAGES_BASE_URL` is set.
-
-### Updating the binaries ###
-
-If you have commited changes to this branch that require new images, you
-should probably update those.
-Simply copy the new image binaries into images/. If necessary, run
-`populate_images.py` before you do any of this, so all the untouched
-images are the correct version. Then, run `create_imgs_package.py --commit "COMMIT MSG"`
-to create a new ZIP file and commit the info.
-If `UHD_IMAGES_BASE_URL` is set and is a local directory, it will move
-the ZIP file to this directory after creating it.
-
-### Updating the binaries ###
-
-Typical workflow:
-
-1. Check out a branch or commit (git checkout FOO)
-2. Update the images/ subdir (`populate_images.py`)
-3. Do some coding, and commit those changes (`git commit`)
-4. Copy new binaries to images/
-5. Commit the new binaries: `create_imgs_package.py --commit "Updated images on branch X"`
-
-### The CPack system ###
-
-Underlying `create_imgs_package.py` is a CPack system, which can be manually
-invoked by:
-
-1. `mkdir build`
-2. `cd build`
-3. `cmake -DCPACK_GENERATOR=<type> ../`
-4. `make package`
-
-The package generator types are described here:
-http://www.cmake.org/Wiki/CMake:CPackPackageGenerators
+ $ ./create_imgs_package.py
+It'll take a few minutes to download and zip them all up.