You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by GitBox <gi...@apache.org> on 2018/12/12 21:47:10 UTC
[GitHub] aditihilbert closed pull request #252: Fix homebrew docs and add
latest linux binary urls
aditihilbert closed pull request #252: Fix homebrew docs and add latest linux binary urls
URL: https://github.com/apache/mynewt-newt/pull/252
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/install/newt_linux.rst b/docs/install/newt_linux.rst
index 8ace7974..57f733bc 100644
--- a/docs/install/newt_linux.rst
+++ b/docs/install/newt_linux.rst
@@ -1,12 +1,12 @@
Installing Newt on Linux
------------------------
-You can install the latest release (1.3.0) of the newt tool from a Debian binary package (amd64). You can also download
+You can install the latest release (1.5.0) of the newt tool from a Debian binary package (amd64). You can also download
and build the latest release version of newt from source.
This page shows you how to:
-1. Set up your computer to download Debian binary packages from the runtimeco APT repository.
+1. Set up your computer to download Debian binary packages from the JuulLabs-OSS APT repository.
**Note:** The key for signing the repository has changed. If you set up your computer before release 1.1.0, you will
need to download and import the public key again.
@@ -20,7 +20,7 @@ If you are installing on an amd64 platform, we recommend that you install from t
See :doc:`prev_releases` to install an earlier version of newt.
-**Note:** We have tested the newt tool binary and apt-get install from the runtimeco APT repository for Ubuntu version
+**Note:** We have tested the newt tool binary and apt-get install from the JuulLabs-OSS APT repository for Ubuntu version
1704. Earlier Ubuntu versions (for example: Ubuntu 14) may have incompatibility with the repository. You can manually
download and install the Debian binary package.
@@ -33,29 +33,33 @@ download and install the Debian binary package.
Setting Up Your Computer to use apt-get to Install the Package
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The newt Debian packages are stored in a private APT repository on **https://github/runtimeco/debian-mynewt**. To use
-apt-get, you must set up the following on your computer to retrieve packages from the repository:
+The newt Debian packages are stored in a private APT repository on **https://github.com/JuulLabs-OSS/debian-mynewt**.
+To use apt-get, you must set up the following on your computer to retrieve packages from the repository:
**Note**: You only need to perform this setup once on your computer. However, if you previously downloaded and imported
-the public key for the runtimeco APT repository, you will need to perform step 2 again as the key has changed.
+the public key for the JuulLabs-OSS APT repository, you will need to perform step 2 again as the key has changed.
-1. Download the public key for the runtimeco APT repository and import the key into the apt keychain.
+1. Download the public key for the JuulLabs-OSS APT repository and import the key into the apt keychain.
2. Add the repository for the binary and source packages to the apt source list.
-Download the public key for the runtimeco apt repo (**Note:** There is a ``-`` after ``apt-key add``):
+Download the public key for the JuulLabs-OSS apt repo (**Note:** There is a ``-`` after ``apt-key add``):
.. code-block:: console
- $ wget -qO - https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/mynewt.gpg.key | sudo apt-key add -
+ $ wget -qO - https://raw.githubusercontent.com/JuulLabs-OSS/debian-mynewt/master/mynewt.gpg.key | sudo apt-key add -
Add the repository for the binary and source packages to the ``mynewt.list`` apt source list file:
.. code-block:: console
$ sudo tee /etc/apt/sources.list.d/mynewt.list <<EOF
- deb https://raw.githubusercontent.com/runtimeco/debian-mynewt/master latest main
+ deb https://raw.githubusercontent.com/JuulLabs-OSS/debian-mynewt/master latest main
EOF
+**Note:** Previously the repository lived under ``runtimeco/debian-mynewt``, and although
+updating should remain working, if it stops pulling in the latest releases, please try updating
+``/etc/apt/sources.list.d/mynewt.list`` and substitute ``runtimeco`` by ``JuulLabs-OSS``.
+
Update the available packages:
.. code-block:: console
@@ -67,7 +71,7 @@ how to manually download and install the binary package.
.. code-block:: console
- W: Failed to fetch https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/dists/latest/main/source/Sources HttpError404
+ W: Failed to fetch https://raw.githubusercontent.com/JuulLabs-OSS/debian-mynewt/master/dists/latest/main/source/Sources HttpError404
Installing the Latest Release of Newt from a Binary Package
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -97,8 +101,8 @@ Download and install the package manually.
.. code-block:: console
- $ wget https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.4.1/newt_1.4.1-1_amd64.deb
- $ sudo dpkg -i newt_1.4.1-1_amd64.deb
+ $ wget https://raw.githubusercontent.com/JuulLabs-OSS/binary-releases/master/mynewt-newt-tools_1.5.0/newt_1.5.0-1_amd64.deb
+ $ sudo dpkg -i newt_1.5.0-1_amd64.deb
See `Checking the Installed Version of Newt`_ to verify that you are using the installed version of newt.
@@ -112,16 +116,16 @@ source.
.. code-block:: console
- $ wget -P /tmp https://github.com/apache/mynewt-newt/archive/mynewt_1_4_1_tag.tar.gz
- $ tar -xzf /tmp/mynewt_1_4_1_tag.tar.gz
+ $ wget -P /tmp https://github.com/apache/mynewt-newt/archive/mynewt_1_5_0_tag.tar.gz
+ $ tar -xzf /tmp/mynewt_1_5_0_tag.tar.gz
#. Run the build.sh to build the newt tool.
.. code-block:: console
- $ cd mynewt-newt-mynewt_1_4_1_tag
+ $ cd mynewt-newt-mynewt_1_5_0_tag
$ ./build.sh
- $ rm /tmp/mynewt_1_4_1_tag.tar.gz
+ $ rm /tmp/mynewt_1_5_0_tag.tar.gz
#. You should see the ``newt/newt`` executable. Move the executable to a bin directory in your PATH:
@@ -148,7 +152,7 @@ Checking the Installed Version of Newt
$ which newt
/usr/bin/newt
$ newt version
- Apache Newt version: 1.4.1
+ Apache Newt version: 1.5.0
2. Get information about newt:
@@ -179,6 +183,7 @@ Checking the Installed Version of Newt
clean Delete build artifacts for one or more targets
create-image Add image header to target binary
debug Open debugger session to target
+ help Help about any command
info Show project info
install Install project dependencies
load Load built target to board
@@ -197,7 +202,7 @@ Checking the Installed Version of Newt
Flags:
-h, --help Help for newt commands
- -j, --jobs int Number of concurrent build jobs (default 8)
+ -j, --jobs int Number of concurrent build jobs (default 4)
-l, --loglevel string Log level (default "WARN")
-o, --outfile string Filename to tee output to
-q, --quiet Be quiet; only display error output
diff --git a/docs/install/newt_mac.rst b/docs/install/newt_mac.rst
index a2f5c29f..b29c3bbe 100644
--- a/docs/install/newt_mac.rst
+++ b/docs/install/newt_mac.rst
@@ -1,8 +1,8 @@
-Installing Newt on Mac OS
--------------------------
+Installing Newt on macOS
+------------------------
-Newt is supported on Mac OS X 64 bit platforms and has been tested on
-Mac OS 10.10 and higher.
+Newt is supported on macOS 64 bit platforms and has been tested on
+macOS 10.12 and higher.
This page shows you how to:
@@ -30,12 +30,20 @@ You can also extract (or ``git clone``) Homebrew and install it to
Adding the Mynewt Homebrew Tap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If this is your first time installing newt, add the
-**runtimeco/homebrew-mynewt** tap:
+If this is your first time installing newt, add the **JuulLabs-OSS/mynewt**
+tap:
.. code-block:: console
- $ brew tap runtimeco/homebrew-mynewt
+ $ brew tap JuulLabs-OSS/mynewt
+ ==> Tapping juullabs-oss/mynewt
+ Cloning into '/usr/local/Homebrew/Library/Taps/juullabs-oss/homebrew-mynewt'...
+ remote: Enumerating objects: 16, done.
+ remote: Counting objects: 100% (16/16), done.
+ remote: Compressing objects: 100% (13/13), done.
+ remote: Total 16 (delta 12), reused 3 (delta 3), pack-reused 0
+ Unpacking objects: 100% (16/16), done.
+ Tapped 14 formulae (52 files, 51.9KB).
$ brew update
Upgrading to or Installing the Latest Release Version
@@ -44,6 +52,15 @@ Upgrading to or Installing the Latest Release Version
Perform the following to upgrade or install the latest release version
of newt.
+**Note:** The homebrew tap used to live under ``runtimeco/mynewt``, and
+although updating should still work, if the tap stops pulling in the latest
+releases, please try removing the old tap and adding the new one:
+
+.. code-block:: console
+
+ $ brew untap runtimeco/mynewt
+ $ brew tap JuulLabs-OSS/mynewt
+
Upgrading to the Latest Release Version of Newt
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -55,13 +72,13 @@ commands to upgrade to newt latest:
$ brew update
$ brew upgrade mynewt-newt
==> Upgrading 1 outdated package, with result:
- runtimeco/mynewt/mynewt-newt 1.4.1
- ==> Upgrading runtimeco/mynewt/mynewt-newt
- ==> Downloading https://github.com/runtimeco/binary-releases/raw/master/mynewt-newt-tools_1.4.1/mynewt-newt-1.4.1.sierra.bottle.tar.gz
- ==> Downloading from https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.4.1/mynewt-newt-1.4.1.sierra.bottle.tar.gz
+ juullabs-oss/mynewt/mynewt-newt 1.5.0
+ ==> Upgrading juullabs-oss/mynewt/mynewt-newt
+ ==> Downloading https://github.com/juullabs-oss/binary-releases/raw/master/mynewt-newt-tools_1.5.0/mynewt-newt-1.5.0.sierra.bottle.tar.gz
+ ==> Downloading from https://raw.githubusercontent.com/juullabs-oss/binary-releases/master/mynewt-newt-tools_1.5.0/mynewt-newt-1.5.0.sierra.bottle.tar.gz
######################################################################## 100.0%
- ==> Pouring mynewt-newt-1.4.1.sierra.bottle.tar.gz
- 🍺 /usr/local/Cellar/mynewt-newt/1.4.1: 3 files, 7.9MB
+ ==> Pouring mynewt-newt-1.5.0.sierra.bottle.tar.gz
+ 🍺 /usr/local/Cellar/mynewt-newt/1.5.0: 3 files, 8.1MB
Installing the Latest Release Version of Newt
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -72,13 +89,14 @@ Run the following command to install the latest release version of newt:
$ brew update
$ brew install mynewt-newt
- ==> Installing mynewt-newt from runtimeco/mynewt
- ==> Downloading https://github.com/runtimeco/binary-releases/raw/master/mynewt-newt-tools_1.4.1/mynewt-newt-1.4.1.sierra.bottle.tar.gz
- Already downloaded: /Users/gavin/Library/Caches/Homebrew/mynewt-newt-1.4.1.sierra.bottle.tar.gz
- ==> Pouring mynewt-newt-1.4.1.sierra.bottle.tar.gz
- 🍺 /usr/local/Cellar/mynewt-newt/1.4.1: 3 files, 7.9MB
+ ==> Installing mynewt-newt from juullabs-oss/mynewt
+ ==> Downloading https://github.com/juullabs-oss/binary-releases/raw/master/mynewt-newt-tools_1.5.0/mynewt-newt-1.5.0.sierra.bottle
+ ==> Downloading from https://raw.githubusercontent.com/JuulLabs-OSS/binary-releases/master/mynewt-newt-tools_1.5.0/mynewt-newt-
+ ######################################################################## 100.0%
+ ==> Pouring mynewt-newt-1.5.0.sierra.bottle.tar.gz
+ 🍺 /usr/local/Cellar/mynewt-newt/1.5.0: 3 files, 8.1MB
-**Notes:** Homebrew bottles for newt are available for Mac OS Sierra. If you are running an earlier version of Mac OS,
+**Notes:** Homebrew bottles for newt are available for macOS Sierra. If you are running an earlier version of macOS,
the installation will install the latest version of Go and compile newt locally.
Checking the Installed Version
@@ -91,7 +109,7 @@ Check that you are using the installed version of newt:
$ which newt
/usr/local/bin/newt
$ newt version
- Apache Newt version: 1.4.1
+ Apache Newt version: 1.5.0
**Note:** If you previously built newt from source and the output of
``which newt`` shows
@@ -128,6 +146,7 @@ Get information about newt:
clean Delete build artifacts for one or more targets
create-image Add image header to target binary
debug Open debugger session to target
+ help Help about any command
info Show project info
install Install project dependencies
load Load built target to board
@@ -146,7 +165,7 @@ Get information about newt:
Flags:
-h, --help Help for newt commands
- -j, --jobs int Number of concurrent build jobs (default 8)
+ -j, --jobs int Number of concurrent build jobs (default 4)
-l, --loglevel string Log level (default "WARN")
-o, --outfile string Filename to tee output to
-q, --quiet Be quiet; only display error output
@@ -186,4 +205,4 @@ you can run:
.. code-block:: console
- $ brew switch mynewt-newt 1.4.1
+ $ brew switch mynewt-newt 1.5.0
diff --git a/docs/install/prev_releases.rst b/docs/install/prev_releases.rst
index 6fb1614f..6dfa666b 100644
--- a/docs/install/prev_releases.rst
+++ b/docs/install/prev_releases.rst
@@ -1,10 +1,10 @@
Installing Previous Releases of Newt
------------------------------------
-This page shows you how to install previous releases of newt for Mac OS, Linux, and Windows.
+This page shows you how to install previous releases of newt for macOS, Linux, and Windows.
-Mac OS
-~~~~~~
+macOS
+~~~~~
You can install previous releases of newt using ``mynewt-newt@X.Y`` Homebrew formulas, where X.Y is a version number.
@@ -48,11 +48,15 @@ Linux
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Version | Download |
+===========+====================================================================================================================================================+
- | 1.0.0 | `newt\_1.0.0-1\_amd64.deb <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.0.0/newt_1.0.0-1_amd64.deb>`__ |
+ | 1.0.0 | `newt\_1.0.0-1\_amd64.deb <https://raw.githubusercontent.com/JuulLabs-OSS/binary-releases/master/mynewt-newt-tools_1.0.0/newt_1.0.0-1_amd64.deb>`__ |
+ +-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | 1.1.0 | `newt\_1.1.0-1\_amd64.deb <https://raw.githubusercontent.com/JuulLabs-OSS/binary-releases/master/mynewt-newt-tools_1.1.0/newt_1.1.0-1_amd64.deb>`__ |
+ +-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | 1.3.0 | `newt\_1.3.0-1\_amd64.deb <https://raw.githubusercontent.com/JuulLabs-OSS/binary-releases/master/mynewt-newt-tools_1.3.0/newt_1.3.0-1_amd64.deb>`__ |
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
- | 1.1.0 | `newt\_1.1.0-1\_amd64.deb <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.1.0/newt_1.1.0-1_amd64.deb>`__ |
+ | 1.4.0 | `newt\_1.4.0-1\_amd64.deb <https://raw.githubusercontent.com/JuulLabs-OSS/binary-releases/master/mynewt-newt-tools_1.4.0/newt_1.4.0-1_amd64.deb>`__ |
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
- | 1.3.0 | `newt\_1.3.0-1\_amd64.deb <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.3.0/newt_1.3.0-1_amd64.deb>`__ |
+ | 1.4.1 | `newt\_1.4.1-1\_amd64.deb <https://raw.githubusercontent.com/JuulLabs-OSS/binary-releases/master/mynewt-newt-tools_1.4.1/newt_1.4.1-1_amd64.deb>`__ |
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
2. Run the ``sudo apt-get remove newt`` command to remove the the current installation.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services