From 7f24319955127db8435bce4eb12a944ab38dda9e Mon Sep 17 00:00:00 2001 From: Slawomir Kasenberg Date: Tue, 22 Jul 2025 09:25:21 +0200 Subject: [PATCH 1/2] docs: install: Update install instructions for Linux --- docs/install/newt_linux.rst | 141 +++++------------------------------- 1 file changed, 17 insertions(+), 124 deletions(-) diff --git a/docs/install/newt_linux.rst b/docs/install/newt_linux.rst index cfb11de341..13bc169e1e 100644 --- a/docs/install/newt_linux.rst +++ b/docs/install/newt_linux.rst @@ -1,149 +1,40 @@ Installing Newt on Linux ------------------------ -You can install the latest release (1.9.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. +You can install the latest release of the newt tool from https://mynewt.apache.org/download or download latest sources +directly from GitHub https://github.com/apache/mynewt-newt and build your binary localy. -This page shows you how to: - -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. - -2. Install the latest release version of newt from a Debian binary package. You can use apt-get to install the package - or manually download and install the Debian binary package. - -3. Download, build, and install the latest release version of newt from source. - -If you are installing on an amd64 platform, we recommend that you install from the binary package. - -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 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. - -**Note:** See :doc:`../../misc/go_env` if you want to: - -- Use the newt tool with the latest updates from the master branch. The master branch may be unstable and we recommend - that you use the latest stable release version. -- Contribute to the newt tool. - -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.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 JuulLabs-OSS APT repository, you will need to perform step 2 again as the key has changed. - -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 JuulLabs-OSS apt repo (**Note:** There is a ``-`` after ``apt-key add``): - -.. code-block:: console - - $ 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 <> ~/.bashrc Checking the Installed Version of Newt ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -155,7 +46,7 @@ Checking the Installed Version of Newt $ which newt /usr/bin/newt $ newt version - Apache Newt version: 1.9.0 + Apache Newt 1.13.0 / c6bf556 / 2024-11-15_06:58 2. Get information about newt: @@ -185,6 +76,7 @@ Checking the Installed Version of Newt apropos Search manual page names and descriptions build Build one or more targets clean Delete build artifacts for one or more targets + completion Generate the autocompletion script for the specified shell create-image Add image header to target binary debug Open debugger session to target docs Project documentation generation commands @@ -212,6 +104,7 @@ Checking the Installed Version of Newt -l, --loglevel string Log level (default "WARN") -o, --outfile string Filename to tee output to -q, --quiet Be quiet; only display error output + --shallow int Use shallow clone for git repositories up to specified number of commits -s, --silent Be silent; don't output anything -v, --verbose Enable verbose output when executing commands From dae11e3a716ca323615835a112bbc94616829105 Mon Sep 17 00:00:00 2001 From: Slawomir Kasenberg Date: Tue, 22 Jul 2025 13:53:55 +0200 Subject: [PATCH 2/2] docs: install: Update install instructions for Windows --- docs/install/newt_windows.rst | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/docs/install/newt_windows.rst b/docs/install/newt_windows.rst index 30cb2ec93d..25852807e2 100644 --- a/docs/install/newt_windows.rst +++ b/docs/install/newt_windows.rst @@ -13,7 +13,7 @@ This guide shows you how to perform the following: 1. Install MSYS2/MinGW. 2. Install Git. -3. Install latest release (1.8.0) of newt from binary. +3. Install latest release of newt from binary. 4. Install go for building newt from source. 5. Install latest release of newt from source. @@ -93,7 +93,7 @@ You can install the latest release of newt from binary. It has been tested on Wi 1. Start a MinGW terminal. -2. Download the newt binary tar file `apache-mynewt-newt-bin-windows-1.8.0.tgz `__. +2. Download the latest newt binary tar file for Windows from https://mynewt.apache.org/download. 3. Extract the file: @@ -102,13 +102,13 @@ You can install the latest release of newt from binary. It has been tested on Wi .. code-block:: console - $ tar -xzf apache-mynewt-newt-bin-windows-1.8.0.tgz -C $GOPATH/bin --strip-components=1 apache-mynewt-newt-bin-windows-1.8.0/newt.exe + $ tar -xzf apache-mynewt-newt-bin-windows-x.x.x.tgz -C $GOPATH/bin --strip-components=1 apache-mynewt-newt-bin-windows-x.x.x/newt.exe - If you are installing newt for the first time and do not have a Go workspace setup, you can extract into /usr/bin directory: .. code-block:: console - $ tar -xzf apache-mynewt-newt-bin-windows-1.8.0.tgz -C /usr/bin --strip-components=1 apache-mynewt-newt-bin-windows-1.8.0/newt.exe + $ tar -xzf apache-mynewt-newt-bin-windows-x.x.x.tgz -C /usr/bin --strip-components=1 apache-mynewt-newt-bin-windows-x.x.x/newt.exe 4. Verify the installed version of newt. See `Checking the Installed Version`_. @@ -136,20 +136,19 @@ source. 1. Start a MinGw terminal. -2. Download and unpack the newt source: +2. Download and unpack the newt source (get version number from https://mynewt.apache.org/download): .. code-block:: console - $ wget -P /tmp https://github.com/apache/mynewt-newt/archive/mynewt_1_8_0_tag.tar.gz - $ tar -xzf /tmp/mynewt_1_8_0_tag.tar.gz + $ wget -P /tmp https://github.com/apache/mynewt-newt/archive/mynewt_x_x_x_tag.tar.gz + $ tar -xzf /tmp/mynewt_x_x_x_tag.tar.gz 3. Run the build.sh to build the newt tool. .. code-block:: console - $ cd mynewt-newt-mynewt_1_8_0_tag + $ cd mynewt-newt $ MSYS=winsymlinks:nativestrict ./build.sh - $ rm /tmp/mynewt_1_8_0_tag.tar.gz 4. You should see the ``newt/newt.exe`` executable. Move the executable to a bin directory in your PATH: @@ -173,14 +172,16 @@ Checking the Installed Version .. code-block:: console + $ which newt + /usr/bin/newt $ newt version - Apache Newt 1.8.0 / ab96a8a-dirty / 2020-03-18_23:25 + Apache Newt 1.13.0 / c6bf556 / 2024-11-15_06:58 2. Get information about newt: .. code-block:: console - $ newt help + $ newt Newt allows you to create your own embedded application based on the Mynewt operating system. Newt provides both build and package management in a single tool, which allows you to compose an embedded application, and set of @@ -204,6 +205,7 @@ Checking the Installed Version apropos Search manual page names and descriptions build Build one or more targets clean Delete build artifacts for one or more targets + completion Generate the autocompletion script for the specified shell create-image Add image header to target binary debug Open debugger session to target docs Project documentation generation commands @@ -225,13 +227,14 @@ Checking the Installed Version version Display the Newt version number Flags: - --escape Apply Windows escapes to shell commands (default true) + --escape Apply Windows escapes to shell commands -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 + --shallow int Use shallow clone for git repositories up to specified number of commits -s, --silent Be silent; don't output anything -v, --verbose Enable verbose output when executing commands - Use "newt [command] --help" for more information about a command. + Use "newt [command] --help" for more information about a command. \ No newline at end of file