commit 2c48c7178644bc4ba219791ed56e4078ed9e9d18 Author: Georg Koppen <gk@torproject.org> Date: Mon May 18 07:22:16 2020 +0000 Bug 34247: Update and fix errors in README --- README | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README b/README index 8e97e2f..a95f466 100644 --- a/README +++ b/README @@ -5,9 +5,7 @@ Installing build dependencies ----------------------------- To build Tor Browser, you need a Linux distribution that has support -for runc (such as Debian jessie, Ubuntu 16.04, Fedora 20, etc ...). -On Debian jessie, the runc package is available in backports. On Debian -stretch, the runc package is available in the main repository. +for runc (such as Debian Buster, Ubuntu 16.04, Fedora 30, etc ...). Your user account should have sudo access, which is required to be able to extract container file systems, start containers and copy files to and @@ -71,6 +69,7 @@ name to the makefile target: $ make nightly-linux-x86_64 $ make nightly-linux-i686 $ make nightly-windows-i686 + $ make nightly-windows-x86_64 $ make nightly-osx-x86_64 $ make nightly-android-armv7 $ make nightly-android-aarch64 @@ -81,13 +80,15 @@ When you want to quickly do a build to test a change, you can use the testbuild makefile target, and find the build in the testbuild directory. The build will be the same as regular alpha builds, except that in order to make the build faster, only the en-US locale will be built, and no -mar file will be created. +mar file will be created. If you want to base your testbuild on the latest +nightly code insted, rename rbm.local.conf.example to rbm.local.conf +and adapt the torbrowser-testbuild option accordingly. Updating git sources -------------------- -You can run "make fetch" to fetch the latest sources from git for all +You can run `make fetch` to fetch the latest sources from git for all components included in Tor Browser. You should run this if you want to make a nightly build with the latest commits, and you disabled automatic fetching of new commits for nightly builds in rbm.local.conf. @@ -122,14 +123,14 @@ option. You can look at the Makefile to find the rbm command for what you want to build, and add the --output-dir option. For example, if you want to build Tor Browser nightly for linux-x86_64: - ./rbm/rbm build release --output-dir=/var/builds/nightly/2017-01-23 \ + ./rbm/rbm build release --output-dir=/var/builds/nightly/2020-05-23 \ --target nightly --target torbrowser-linux-x86_64 The files will be put in the directory selected by --output-dir in a subdirectory named as the version number (or current date for nightly). To remove this version subdirectory, add the noversiondir target: - ./rbm/rbm build release --output-dir=/var/builds/nightly/2017-01-23 \ + ./rbm/rbm build release --output-dir=/var/builds/nightly/2020-05-23 \ --target nightly --target torbrowser-linux-x86_64 \ --target noversiondir @@ -166,14 +167,14 @@ in the rbm.local.conf file. Cleaning obsolete files and containers images --------------------------------------------- -You can run 'make clean' to clean old build files and containers that +You can run `make clean` to clean old build files and containers that are no longer used in current builds. Before doing that, you need to configure the branches and build targets you are using in the rbm.local.conf file. The cleaning script will check out all the configured branches to create a list of used build files, and delete the files from the 'out' directory that are not used. If you want to see the list of files and containers that would be removed without doing it, you can -use 'make clean-dry-run'. +use `make clean-dry-run`. Building without containers (Android builds only) @@ -181,12 +182,10 @@ Building without containers (Android builds only) By default the build is done inside containers. Adding the no_containers target will disable the use of containers. The following commands can -be used to build the alpha version for android-armv7 and android-x86: +be used to build the alpha version for e.g. android-armv7: ./rbm/rbm build release --target no_containers --target testbuild \ --target torbrowser-android-armv7 - ./rbm/rbm build release --target no_containers --target testbuild \ - --target torbrowser-android-x86 Note: the logs will still show the use and creation of a container image called "containers_disabled". This is due to the way we disable the use @@ -198,7 +197,7 @@ builds, and will require that you run Debian Stretch and install build dependencies for all the components that are built. This can be done with the following command: - # apt-get install build-essential python automake libtool zip unzip + # apt-get install build-essential python automake libtool zip unzip \ autoconf2.13 openjdk-8-jdk gettext-base autotools-dev \ automake autoconf libtool autopoint libssl-dev \ pkg-config zlib1g-dev libparallel-forkmanager-perl \ @@ -218,9 +217,10 @@ Hacking on the Tor Browser build The file README.HACKING tries to list the main things to know when making changes to the Tor Browser build. + Description of makefile rules ----------------------------- -You can find a description of the makefile rules in the README.MAKEFILE +You can find a description of the Makefile rules in the README.MAKEFILE file.